diff options
| author | Marak <[email protected]> | 2015-07-08 15:37:04 -0700 |
|---|---|---|
| committer | Marak <[email protected]> | 2015-07-08 15:37:04 -0700 |
| commit | b0765aea125e9d89991d382e46c758860dc866aa (patch) | |
| tree | 03b0ae12519b82f3472c0734d4ba61b17cc341bc /build/src | |
| parent | c9ebc064bf402ea2d12fb4bccdbdc4b9c231452b (diff) | |
| download | faker-b0765aea125e9d89991d382e46c758860dc866aa.tar.xz faker-b0765aea125e9d89991d382e46c758860dc866aa.zip | |
[docs] Updating README and build script.
Diffstat (limited to 'build/src')
| -rw-r--r-- | build/src/docs.md | 69 |
1 files changed, 43 insertions, 26 deletions
diff --git a/build/src/docs.md b/build/src/docs.md index 2787a960..03ee76f0 100644 --- a/build/src/docs.md +++ b/build/src/docs.md @@ -29,33 +29,13 @@ var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many properties -## Dependent tools - -### 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 - -### Meteor - -#### Meteor installation - - meteor add practicalmeteor:faker - -#### meteor usage, both client and server +## API - 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}}} ## Localization -As of version `v2.0.0` faker.js supports 27 different language definition packs. +As of version `v2.0.0` faker.js supports over 27 different language definition packs. The default language is set to English. @@ -65,11 +45,21 @@ Setting a new locale is simple: // sets locale to de faker.locale = "de"; ``` -Read further for complete list of locales. -## API +{{LOCALES}} + +### Individual Localization Packages + +As of vesion `v3.0.0` faker.js supports incremental loading of locales. + +By default, requiring `faker` will include *all* locale data. + +In a production environment, you may only want to include the locale data for a specific set of locales. + +```js +// loads only de locale +var faker = require('faker/locale/de'); -{{{API}}} ## Tests @@ -78,6 +68,33 @@ Read further for complete list of locales. You can view a code coverage report generated in coverage/lcov-report/index.html. +## Projects Built with faker.js + +### 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 + +**Want to see your project added here? Let us know!** + +### Meteor + +#### Meteor installation + + meteor add practicalmeteor:faker + +#### meteor usage, both client and server + + 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 + + ## Authors #### Matthew Bergman & Marak Squires |
