aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarak Squires <[email protected]>2010-05-16 03:06:56 -0400
committerMarak Squires <[email protected]>2010-05-16 03:06:56 -0400
commita40b92f509228f012c1607604efb2c98f49d8285 (patch)
treea66c414144fcea83a7ac4168e8bdf3e41cd134e9
parentf33ea9b0b196e4e0753101f479381fcd360c7807 (diff)
downloadfaker-a40b92f509228f012c1607604efb2c98f49d8285.tar.xz
faker-a40b92f509228f012c1607604efb2c98f49d8285.zip
updating docs
-rw-r--r--BUILD/docs.js10
-rw-r--r--Faker.js2
-rw-r--r--Readme.md9
-rw-r--r--demo.html2
4 files changed, 18 insertions, 5 deletions
diff --git a/BUILD/docs.js b/BUILD/docs.js
index 0632039a..ac47cc63 100644
--- a/BUILD/docs.js
+++ b/BUILD/docs.js
@@ -11,13 +11,19 @@
<script src = "Faker.js" type = "text/javascript"></script>
<script>
- var randomName = Faker.Name.findName();
+ var randomName = Faker.Name.findName(); // Caitlyn Kerluke
+ var randomEmail = Faker.Internet.email(); // [email protected]
+ var randomCard = Faker.Helpers.createCard(); // contact card containing many properties
</script>
### node.js -
var Faker = require('./Faker');
- var randomName = Faker.Name.findName();
+
+ var randomName = Faker.Name.findName(); // Rowan Nikolaus
+ var randomEmail = Faker.Internet.email(); // [email protected]
+ var randomCard = Faker.Helpers.createCard(); // contact card containing many properties
+
## API
diff --git a/Faker.js b/Faker.js
index aab383bd..ab302daa 100644
--- a/Faker.js
+++ b/Faker.js
@@ -1,4 +1,4 @@
-/*************** AUTOGENERATED @ 1273990231008 ***************
+/*************** AUTOGENERATED @ 1273993594437 ***************
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 05b7bf35..6efc0033 100644
--- a/Readme.md
+++ b/Readme.md
@@ -6,11 +6,16 @@
<script src = "Faker.js" type = "text/javascript"></script>
<script>
- var randomName = Faker.Name.findName();
+ var randomName = Faker.Name.findName(); // Caitlyn Kerluke
+ var randomEmail = Faker.Internet.email(); // [email protected]
+ var randomCard = Faker.Helpers.createCard(); // contact card containing many properties
</script>
### node.js -
var Faker = require('./Faker');
- var randomName = Faker.Name.findName();
+ var randomName = Faker.Name.findName(); // Rowan Nikolaus
+ var randomEmail = Faker.Internet.email(); // [email protected]
+ var randomCard = Faker.Helpers.createCard(); // contact card containing many properties
+
## 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><li>generateDataSet</li><li>createCard</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>
## Authors
diff --git a/demo.html b/demo.html
index 67554a50..0fc40e5b 100644
--- a/demo.html
+++ b/demo.html
@@ -60,6 +60,8 @@
</script>
</head>
<body>
+ <h1>Faker.js - generate massive amounts of fake data in Node.js and the browser</h1>
+ <a href="http://github.com/marak/Faker.js/"><img style="position:absolute; z-index:10; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub" /></a>
<input id = "generate" type = "button" value = "generate one random card as HTML" />
<input id = "generateSet" type = "button" value = "generate an assosative array of random cards as JSON" />
card count : <input id = "cardCount" type = "text" size = "3" value = "5" /><br/><br/>