adding more comments

2 files changed, 18 insertions, 1 deletions

diff --git a/BUILD/docs.js b/BUILD/docs.js
index 8fc03003..0632039a 100644
--- a/BUILD/docs.js
+++ b/BUILD/docs.js
@@ -16,7 +16,7 @@
 
 ### node.js - 
 
-      var Faker = require(./Faker);
+      var Faker = require('./Faker');
       var randomName = Faker.Name.findName();
 
 
diff --git a/index.js b/index.js
index 722f1ebf..955b4a66 100644
--- a/index.js
+++ b/index.js
@@ -1,3 +1,20 @@
+/* 
+   
+   this index.js file is used for including the Faker libraryas a CommonJS module
+   
+   you can include the Faker library into your existing node.js application by requiring the entire /Faker directory
+
+    var Faker = require(./Faker);
+    var randomName = Faker.Name.findName();
+ 
+   you can also simply include the "Faker.js" file which is the auto-generated bundled version of the Faker library
+   if you plan on modifying the Faker library you should be performing your changes in the /lib/ directory
+
+    var Faker = require(./customAppPath/Faker);
+    var randomName = Faker.Name.findName();
+
+*/
+
 exports.Name = require('./lib/name');
 exports.Address = require('./lib/address');
 exports.PhoneNumber = require('./lib/phone_number');