Skip to content

Commit

Permalink
[docs] Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Marak committed Jul 8, 2015
1 parent ef2fca0 commit c9ebc06
Showing 1 changed file with 112 additions and 91 deletions.
203 changes: 112 additions & 91 deletions Readme.md
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![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)
[![Build Status](https://travis-ci.org/Marak/faker.js.svg?branch=master)](https://travis-ci.org/Marak/faker.js)

[![npm version](https://badge.fury.io/js/faker.svg)](http://badge.fury.io/js/faker)

Expand All @@ -23,7 +23,7 @@

### Node.js

var faker = require('./faker');
var faker = require('faker');

var randomName = faker.name.findName(); // Rowan Nikolaus
var randomEmail = faker.internet.email(); // [email protected]
Expand Down Expand Up @@ -53,7 +53,7 @@ See: https://github.com/lestoni/faker-cli
var randomEmail = faker.internet.email(); // [email protected]
var randomCard = faker.helpers.createCard(); // random contact card containing many properties

### Localization
## Localization

As of version `v2.0.0` faker.js supports 27 different language definition packs.

Expand All @@ -69,12 +69,87 @@ Read further for complete list of locales.

## API

* locales
* de
* de_AT
* de_CH
* en
* en_AU
* en_BORK
* en_CA
* en_GB
* en_IND
* en_US
* en_au_ocker
* es
* fa
* fr
* fr_CA
* ge
* it
* ja
* ko
* nb_NO
* nep
* nl
* pl
* pt_BR
* ru
* sk
* sv
* tr
* uk
* vi
* zh_CN
* zh_TW
* locale
* 0
* 1
* localeFallback
* 0
* 1
* definitions
* name
* address
* company
* lorem
* hacker
* phone_number
* finance
* internet
* commerce
* title
* separator
* fake
* random
* number
* array_element
* object_element
* uuid
* boolean
* helpers
* randomNumber
* randomize
* slugify
* replaceSymbolWithNumber
* replaceSymbols
* shuffle
* mustache
* createCard
* contextualCard
* userCard
* createTransaction
* name
* firstName
* lastName
* findName
* jobTitle
* prefix
* suffix
* title
* jobDescriptor
* jobArea
* jobType
* address
* zipCode
* city
Expand All @@ -83,28 +158,15 @@ Read further for complete list of locales.
* streetName
* streetAddress
* streetSuffix
* streetPrefix
* secondaryAddress
* county
* country
* countryCode
* state
* stateAbbr
* latitude
* longitude
* phone
* phoneNumber
* phoneNumberFormat
* phoneFormats
* internet
* avatar
* email
* userName
* domainName
* domainSuffix
* domainWord
* ip
* userAgent
* color
* password
* company
* suffixes
* companyName
Expand All @@ -117,6 +179,15 @@ Read further for complete list of locales.
* bsAdjective
* bsBuzz
* bsNoun
* finance
* account
* accountName
* mask
* amount
* transactionType
* currencyCode
* currencyName
* currencySymbol
* image
* image
* avatar
Expand All @@ -140,86 +211,36 @@ Read further for complete list of locales.
* sentences
* paragraph
* paragraphs
* helpers
* randomNumber
* randomize
* slugify
* replaceSymbolWithNumber
* shuffle
* mustache
* createCard
* contextualCard
* userCard
* createTransaction
* date
* past
* future
* between
* recent
* random
* number
* array_element
* object_element
* uuid
* finance
* account
* accountName
* mask
* amount
* transactionType
* currencyCode
* currencyName
* currencySymbol
* hacker
* abbreviation
* adjective
* noun
* verb
* ingverb
* phrase
* locales
* de
* de_AT
* de_CH
* en
* en_AU
* en_BORK
* en_CA
* en_GB
* en_IND
* en_US
* en_au_ocker
* es
* fa
* fr
* it
* ja
* ko
* nb_NO
* nep
* nl
* pl
* pt_BR
* ru
* sk
* sv
* vi
* zh_CN
* locale
* 0
* 1
* localeFallback
* 0
* 1
* definitions
* name
* address
* company
* lorem
* hacker
* phone_number
* finance
* internet
* internet
* avatar
* email
* userName
* protocol
* url
* domainName
* domainSuffix
* domainWord
* ip
* userAgent
* color
* mac
* password
* phone
* phoneNumber
* phoneNumberFormat
* phoneFormats
* date
* past
* future
* between
* recent


## Tests
Expand Down

0 comments on commit c9ebc06

Please sign in to comment.