aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarak Squires <[email protected]>2010-05-15 23:07:51 -0400
committerMarak Squires <[email protected]>2010-05-15 23:07:51 -0400
commita4f5e55984ffcd07cab9568ede95696b9111a8fc (patch)
tree306d35acb7c2a57be4baff66abbb0091ba4098fd
parentfac47a356cfd74e8f6d5268779f3c0e2c9240096 (diff)
downloadfaker-a4f5e55984ffcd07cab9568ede95696b9111a8fc.tar.xz
faker-a4f5e55984ffcd07cab9568ede95696b9111a8fc.zip
cleaning up project
-rw-r--r--BUILD/main.js2
-rw-r--r--Faker.js2
-rw-r--r--Readme.md2
-rw-r--r--index.js8
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();
</script>
### node.js -
- var Faker = require(./Faker);
+ var Faker = require('./Faker');
var randomName = Faker.Name.findName();
## API
<ul><li>Name<ul><li>findName</li></ul></li><li>Address<ul><li>zipCode</li><li>city</li><li>streetName</li><li>streetAddress</li><li>secondaryAddress</li><li>ukCounty</li><li>ukCountry</li></ul></li><li>PhoneNumber<ul><li>phoneNumber</li></ul></li><li>Internet<ul><li>email</li><li>userName</li><li>domainName</li><li>domainWord</li></ul></li><li>Company<ul><li>companyName</li><li>companySuffix</li><li>catchPhrase</li><li>bs</li></ul></li><li>Lorem<ul><li>words</li><li>sentence</li><li>sentences</li><li>paragraph</li></ul></li><li>Helpers<ul><li>randomNumber</li><li>randomize</li><li>replaceSymbolWithNumber</li><li>shuffle</li></ul></li><li>definitions<ul><li>first_name</li><li>last_name</li><li>name_prefix</li><li>name_suffix</li><li>us_state</li><li>us_state_abbr</li><li>city_prefix</li><li>city_suffix</li><li>street_suffix</li><li>uk_county</li><li>uk_country</li><li>catch_phrase_adjective</li><li>catch_phrase_descriptor</li><li>catch_phrase_noun</li><li>bs_adjective</li><li>bs_buzz</li><li>bs_noun</li><li>domain_suffix</li><li>lorem</li><li>phone_formats</li></ul></li></ul>
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');