From a4f5e55984ffcd07cab9568ede95696b9111a8fc Mon Sep 17 00:00:00 2001 From: Marak Squires Date: Sat, 15 May 2010 23:07:51 -0400 Subject: cleaning up project --- BUILD/main.js | 2 ++ Faker.js | 2 +- Readme.md | 2 +- index.js | 8 +++++--- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/BUILD/main.js b/BUILD/main.js index 74e4b698..d3e25feb 100644 --- a/BUILD/main.js +++ b/BUILD/main.js @@ -4,6 +4,7 @@ MODIFYING THIS FILE IS FINE, BUT YOU REALLY SHOULD BE MODIFYING THE LIBRARY DIRECTLY AND REGENERATING THIS FILE USING BUILD.js!!!! + Faker.js - Written by Matthew Bergman and Marak Squires USAGE: @@ -20,6 +21,7 @@ var Faker = require(./Faker); var randomName = Faker.Name.findName(); + */ var Faker = {}; diff --git a/Faker.js b/Faker.js index 1ea90612..21286b8d 100644 --- a/Faker.js +++ b/Faker.js @@ -1,4 +1,4 @@ -/*************** AUTOGENERATED @ 1273978166192 *************** +/*************** AUTOGENERATED @ 1273979263708 *************** WARNING: THIS FILE WAS AUTOGENERATED BY THE FAKER BUILD SCRIPT MODIFYING THIS FILE IS FINE, BUT YOU REALLY SHOULD BE MODIFYING THE LIBRARY DIRECTLY AND REGENERATING THIS FILE USING BUILD.js!!!! diff --git a/Readme.md b/Readme.md index 4a69648f..2043e2ba 100644 --- a/Readme.md +++ b/Readme.md @@ -9,7 +9,7 @@ var randomName = Faker.Name.findName(); ### node.js - - var Faker = require(./Faker); + var Faker = require('./Faker'); var randomName = Faker.Name.findName(); ## API diff --git a/index.js b/index.js index 955b4a66..2b32940c 100644 --- a/index.js +++ b/index.js @@ -1,6 +1,6 @@ /* - this index.js file is used for including the Faker libraryas a CommonJS module + this index.js file is used for including the Faker library as a CommonJS module you can include the Faker library into your existing node.js application by requiring the entire /Faker directory @@ -8,11 +8,13 @@ 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(); + + if you plan on modifying the Faker library you should be performing your changes in the /lib/ directory + */ exports.Name = require('./lib/name'); -- cgit v1.2.3