From 219b5ac7f604e6d85f0eae65463cb50b2cd49ffb Mon Sep 17 00:00:00 2001 From: Erica Clark Date: Sat, 8 Jan 2022 14:52:57 -0800 Subject: chore: bring readme changes from shepherd repo --- build/src/docs.md | 262 ------------------------------------------------------ 1 file changed, 262 deletions(-) delete mode 100644 build/src/docs.md (limited to 'build/src') diff --git a/build/src/docs.md b/build/src/docs.md deleted file mode 100644 index d04d567e..00000000 --- a/build/src/docs.md +++ /dev/null @@ -1,262 +0,0 @@ -# faker.js - generate massive amounts of fake data in the browser and node.js - -![Faker.js](https://raw.githubusercontent.com/Marak/faker.js/master/logo.png) - -[![Build Status](https://travis-ci.org/Marak/faker.js.svg?branch=master)](https://travis-ci.org/Marak/faker.js) [![Coverage Status](https://coveralls.io/repos/github/Marak/faker.js/badge.svg?branch=master)](https://coveralls.io/github/Marak/faker.js?branch=master) - -[![npm version](https://badge.fury.io/js/faker.svg)](http://badge.fury.io/js/faker) - -[![OpenCollective](https://opencollective.com/fakerjs/backers/badge.svg)](#backers) -[![OpenCollective](https://opencollective.com/fakerjs/sponsors/badge.svg)](#sponsors) -[![Gitter chat](https://badges.gitter.im/marak/faker.js.png)](https://gitter.im/Faker-js/community) - -## Demo - -[https://rawgit.com/Marak/faker.js/master/examples/browser/index.html](https://rawgit.com/Marak/faker.js/master/examples/browser/index.html) - -### Faker Cloud - -Don't have a local development setup ready? - -Try our hosted version of Faker at [https://fakercloud.com/api](https://fakercloud.com/api) - -https://github.com/faker/faker-cloud - -## Usage - -### Browser - -```html - - -``` - -### Node.js - -```js - var faker = require('faker'); - - var randomName = faker.name.findName(); // Rowan Nikolaus - var randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz - var randomCard = faker.helpers.createCard(); // random contact card containing many properties -``` - -## API - -### JSDoc API Browser - -[http://marak.github.io/faker.js/](http://marak.github.io/faker.js/) - -### API Methods - -{{{API}}} - -### Faker.fake() - -faker.js contains a super useful generator method `Faker.fake` for combining faker API methods using a mustache string format. - -**Example:** - -{{=<% %>=}} - -``` js -console.log(faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}")); -// outputs: "Marks, Dean Sr." -``` - -<%={{ }}=%> - -This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()` - -## Localization - -As of version `v2.0.0` faker.js has support for multiple localities. - -The default language locale is set to English. - -Setting a new locale is simple: - -```js -// sets locale to de -faker.locale = "de"; -``` - -{{LOCALES}} - -### Individual Localization Packages - -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'); -``` - -## Setting a randomness seed - -If you want consistent results, you can set your own seed: - -```js -faker.seed(123); - -var firstRandom = faker.datatype.number(); - -// Setting the seed again resets the sequence. -faker.seed(123); - -var secondRandom = faker.datatype.number(); - -console.log(firstRandom === secondRandom); -``` - -## Tests - -```shell -npm install . -make test -``` - -You can view a code coverage report generated in coverage/lcov-report/index.html. - -## Building faker.js - -faker uses [gulp](http://gulpjs.com/) to automate its build process. Each build operation is a separate task which can be run independently. - -### Browser Bundle - -```shell -npm run browser -``` - -### Building JSDocs - -[JSDOC](https://jsdoc.app/) v3 HTML API documentation - -```shell -npm run jsdoc -``` - -### Building ReadMe - -The `ReadMe.md` file for `faker.js` is automatically generated and should not be modified directly. All updates to `ReadMe.md` should be performed in `./build/src/docs.md` and then the build script should be run. - -```shell -npm run readme -``` - -## Version Release Schedule - -faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible. - -If you require the absolute latest version of `faker.js` the `master` branch @ should always be up to date and working. - -## Maintainer - -#### Marak Squires - -faker.js - Copyright (c) 2020 -Marak Squires -www.marak.com -http://github.com/marak/faker.js/ - -faker.js was inspired by and has used data definitions from: - - * - Copyright (c) 2007-2010 Benjamin Curtis - * - 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 -"Software"), to deal in the Software without restriction, including -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: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -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 -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. - -## Backers - -Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/fakerjs#backer)] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -## Sponsors - -Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/fakerjs#sponsor)] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -- cgit v1.2.3