aboutsummaryrefslogtreecommitdiff
path: root/BUILD/docs.js
diff options
context:
space:
mode:
authorFotoVerite <[email protected]>2014-05-17 15:35:45 -0400
committerFotoVerite <[email protected]>2014-05-17 15:35:45 -0400
commit3eee796fdff9f4226e211f01cd5926d3d05d28ae (patch)
treecdab238c20b7458b34da8f6e9933edbf4c83abea /BUILD/docs.js
parentdaa95b3a4f3eb5131970271be3820ddb45d30022 (diff)
downloadfaker-3eee796fdff9f4226e211f01cd5926d3d05d28ae.tar.xz
faker-3eee796fdff9f4226e211f01cd5926d3d05d28ae.zip
Moving to major new version for change of package name for uppercase to lowercase.
Diffstat (limited to 'BUILD/docs.js')
-rw-r--r--BUILD/docs.js22
1 files changed, 11 insertions, 11 deletions
diff --git a/BUILD/docs.js b/BUILD/docs.js
index f8ce7d82..659d71b6 100644
--- a/BUILD/docs.js
+++ b/BUILD/docs.js
@@ -1,26 +1,26 @@
-# Faker.js - generate massive amounts of fake data in the browser and node.js
+# faker.js - generate massive amounts of fake data in the browser and node.js
<img src = "http://imgur.com/KiinQ.png" border = "0">
## USAGE
### browser -
- <script src = "Faker.js" type = "text/javascript"></script>
+ <script src = "faker.js" type = "text/javascript"></script>
<script>
- var randomName = Faker.Name.findName(); // Caitlyn Kerluke
- var randomEmail = Faker.Internet.email(); // [email protected]
- var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties
+ var randomName = faker.Name.findName(); // Caitlyn Kerluke
+ var randomEmail = faker.Internet.email(); // [email protected]
+ var randomCard = faker.Helpers.createCard(); // random contact card containing many properties
</script>
### node.js -
### usage
- var Faker = require('./Faker');
+ var faker = require('./faker');
- var randomName = Faker.Name.findName(); // Rowan Nikolaus
- var randomEmail = Faker.Internet.email(); // [email protected]
- var randomCard = Faker.Helpers.createCard(); // random contact card containing many properties
+ var randomName = faker.Name.findName(); // Rowan Nikolaus
+ var randomEmail = faker.Internet.email(); // [email protected]
+ var randomCard = faker.Helpers.createCard(); // random contact card containing many properties
## API
@@ -37,10 +37,10 @@ You can view a code coverage report generated in coverage/lcov-report/index.html
####Matthew Bergman & Marak Squires
-Heavily inspired by Benjamin Curtis's Ruby Gem [Faker](http://faker.rubyforge.org/) and Perl's [Data::Faker](http://search.cpan.org/~jasonk/Data-Faker-0.07/lib/Data/Faker.pm)
+Heavily inspired by Benjamin Curtis's Ruby Gem [faker](http://faker.rubyforge.org/) and Perl's [Data::faker](http://search.cpan.org/~jasonk/Data-faker-0.07/lib/Data/faker.pm)
<br/>
-Copyright (c) {{copyrightYear}} Matthew Bergman & Marak Squires http://github.com/marak/Faker.js/
+Copyright (c) {{copyrightYear}} Matthew Bergman & Marak Squires http://github.com/marak/faker.js/
<br/>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the