aboutsummaryrefslogtreecommitdiff
path: root/build/src
diff options
context:
space:
mode:
authorTomasz Ducin <[email protected]>2015-05-10 20:13:26 +0200
committerTomasz Ducin <[email protected]>2015-05-10 20:13:26 +0200
commit55c729b32dfbd86faa3f0ea3a6698288dd15f303 (patch)
treec778094ae9c568e6ec7f2b842d478c0539e4d845 /build/src
parentc0dc1c49a95c87cece7458c4099429fb7556de6a (diff)
downloadfaker-55c729b32dfbd86faa3f0ea3a6698288dd15f303.tar.xz
faker-55c729b32dfbd86faa3f0ea3a6698288dd15f303.zip
updated readme: sources and generated content #170
Diffstat (limited to 'build/src')
-rw-r--r--build/src/docs.md72
1 files changed, 43 insertions, 29 deletions
diff --git a/build/src/docs.md b/build/src/docs.md
index f8e9ca03..1b1e5941 100644
--- a/build/src/docs.md
+++ b/build/src/docs.md
@@ -1,34 +1,45 @@
# faker.js - generate massive amounts of fake data in the browser and node.js
-<img src = "http://imgur.com/KiinQ.png" border = "0">
+
+![Faker.js](http://imgur.com/KiinQ.png)
[![Build Status](https://travis-ci.org/Marak/faker.js.svg?branch=master)](https://travis-ci.org/Marak/Faker.js)
## Demo
-<a href="http://marak.com/faker.js/">http://marak.com/faker.js/</a>
+[http://marak.com/faker.js/](http://marak.com/faker.js/)
+
+## Usage
-## USAGE
+### Browser
-### browser -
+ <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
+ </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
- </script>
+### Node.js
-### node.js -
+ var faker = require('./faker');
-### usage
+ 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 faker = require('./faker');
+## Dependent tools
- 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
+### Fake JSON Schema
+
+Use faker generators to populate JSON Schema samples.
+See: https://github.com/pateketrueke/json-schema-faker/
+
+### CLI
+
+Run faker generators from Command Line.
+See: https://github.com/lestoni/faker-cli
-### Localization
+## Localization
As of version `v2.0.0` faker.js supports 27 different language definition packs.
@@ -47,23 +58,24 @@ Read further for complete list of locales.
{{{API}}}
## Tests
- npm install .
- make test
+
+ npm install .
+ make test
You can view a code coverage report generated in coverage/lcov-report/index.html.
## Authors
-####Matthew Bergman & Marak Squires
+#### Matthew Bergman & Marak Squires
+
+faker.js - Copyright (c) 2014-2015
+Matthew Bergman & Marak Squires
+http://github.com/marak/faker.js/
-<br/>
-Copyright (c) {{copyrightYear}} Matthew Bergman & Marak Squires http://github.com/marak/faker.js/
-<br/>
+faker.js was inspired by and has used data definitions from:
-faker.js was inspired by and has used data definitions from
-<br/>
- https://github.com/stympy/faker/ - Copyright (c) 2007-2010 Benjamin Curtis <br/>
- http://search.cpan.org/~jasonk/Data-Faker-0.07/ - Copyright 2004-2005 by Jason Kohles <br/>
+ * https://github.com/stympy/faker/ - Copyright (c) 2007-2010 Benjamin Curtis
+ * http://search.cpan.org/~jasonk/Data-Faker-0.07/ - Copyright 2004-2005 by Jason Kohles
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -72,10 +84,10 @@ without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
-<br/>
+
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
-<br/>
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -83,3 +95,5 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+