chore: bring readme changes from shepherd repo

1 files changed, 296 insertions, 304 deletions

diff --git a/Readme.md b/Readme.md
index 62926d36..44efe474 100644
--- a/Readme.md
+++ b/Readme.md
@@ -10,39 +10,40 @@
 [![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
+## FAQ - What happened to the original faker.js?
 
-[https://rawgit.com/Marak/faker.js/master/examples/browser/index.html](https://rawgit.com/Marak/faker.js/master/examples/browser/index.html)
+This project was originally created and hosted at https://github.com/marak/Faker.js/ - however around 4th Jan, 2022 - the author decided to delete the repository (for unknown reasons).
 
-### Faker Cloud
+In the interest of the community, it has been decided that faker.js will continue to be maintained here and all help in its development will be appreciated.
 
-Don't have a local development setup ready? 
+## Demo
 
-Try our hosted version of Faker at [https://fakercloud.com/api](https://fakercloud.com/api)
+Coming soon!
 
-https://github.com/faker/faker-cloud
+### Faker Cloud
+
+Coming Soon !
 
 ## Usage
 
 ### Browser
 
 ```html
-    <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
 
 ```js
-    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 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
 ```
 
 ## API
@@ -53,232 +54,232 @@ https://github.com/faker/faker-cloud
 
 ### API Methods
 
-* address
-  * zipCode
-  * zipCodeByState
-  * city
-  * cityPrefix
-  * citySuffix
-  * cityName
-  * streetName
-  * streetAddress
-  * streetSuffix
-  * streetPrefix
-  * secondaryAddress
-  * county
-  * country
-  * countryCode
-  * state
-  * stateAbbr
-  * latitude
-  * longitude
-  * direction
-  * cardinalDirection
-  * ordinalDirection
-  * nearbyGPSCoordinate
-  * timeZone
-* animal
-  * dog
-  * cat
-  * snake
-  * bear
-  * lion
-  * cetacean
-  * horse
-  * bird
-  * cow
-  * fish
-  * crocodilia
-  * insect
-  * rabbit
-  * type
-* commerce
-  * color
-  * department
-  * productName
-  * price
-  * productAdjective
-  * productMaterial
-  * product
-  * productDescription
-* company
-  * suffixes
-  * companyName
-  * companySuffix
-  * catchPhrase
-  * bs
-  * catchPhraseAdjective
-  * catchPhraseDescriptor
-  * catchPhraseNoun
-  * bsAdjective
-  * bsBuzz
-  * bsNoun
-* database
-  * column
-  * type
-  * collation
-  * engine
-* datatype
-  * number
-  * float
-  * datetime
-  * string
-  * uuid
-  * boolean
-  * hexaDecimal
-  * json
-  * array
-* date
-  * past
-  * future
-  * between
-  * betweens
-  * recent
-  * soon
-  * month
-  * weekday
-* fake
-* finance
-  * account
-  * accountName
-  * routingNumber
-  * mask
-  * amount
-  * transactionType
-  * currencyCode
-  * currencyName
-  * currencySymbol
-  * bitcoinAddress
-  * litecoinAddress
-  * creditCardNumber
-  * creditCardCVV
-  * ethereumAddress
-  * iban
-  * bic
-  * transactionDescription
-* git
-  * branch
-  * commitEntry
-  * commitMessage
-  * commitSha
-  * shortSha
-* hacker
-  * abbreviation
-  * adjective
-  * noun
-  * verb
-  * ingverb
-  * phrase
-* helpers
-  * randomize
-  * slugify
-  * replaceSymbolWithNumber
-  * replaceSymbols
-  * replaceCreditCardSymbols
-  * repeatString
-  * regexpStyleStringParse
-  * shuffle
-  * mustache
-  * createCard
-  * contextualCard
-  * userCard
-  * createTransaction
-* image
-  * image
-  * avatar
-  * imageUrl
-  * abstract
-  * animals
-  * business
-  * cats
-  * city
-  * food
-  * nightlife
-  * fashion
-  * people
-  * nature
-  * sports
-  * technics
-  * transport
-  * dataUri
-  * lorempixel
-  * unsplash
-  * lorempicsum
-* internet
-  * avatar
-  * email
-  * exampleEmail
-  * userName
-  * protocol
-  * httpMethod
-  * url
-  * domainName
-  * domainSuffix
-  * domainWord
-  * ip
-  * ipv6
-  * port
-  * userAgent
-  * color
-  * mac
-  * password
-* lorem
-  * word
-  * words
-  * sentence
-  * slug
-  * sentences
-  * paragraph
-  * paragraphs
-  * text
-  * lines
-* mersenne
-  * rand
-  * seed
-  * seed_array
-* music
-  * genre
-* name
-  * firstName
-  * lastName
-  * middleName
-  * findName
-  * jobTitle
-  * gender
-  * prefix
-  * suffix
-  * title
-  * jobDescriptor
-  * jobArea
-  * jobType
-* phone
-  * phoneNumber
-  * phoneNumberFormat
-  * phoneFormats
-* system
-  * fileName
-  * commonFileName
-  * mimeType
-  * commonFileType
-  * commonFileExt
-  * fileType
-  * fileExt
-  * directoryPath
-  * filePath
-  * semver
-* time
-  * recent
-* unique
-* vehicle
-  * vehicle
-  * manufacturer
-  * model
-  * type
-  * fuel
-  * vin
-  * color
-  * vrm
-  * bicycle
+- address
+  - zipCode
+  - zipCodeByState
+  - city
+  - cityPrefix
+  - citySuffix
+  - cityName
+  - streetName
+  - streetAddress
+  - streetSuffix
+  - streetPrefix
+  - secondaryAddress
+  - county
+  - country
+  - countryCode
+  - state
+  - stateAbbr
+  - latitude
+  - longitude
+  - direction
+  - cardinalDirection
+  - ordinalDirection
+  - nearbyGPSCoordinate
+  - timeZone
+- animal
+  - dog
+  - cat
+  - snake
+  - bear
+  - lion
+  - cetacean
+  - horse
+  - bird
+  - cow
+  - fish
+  - crocodilia
+  - insect
+  - rabbit
+  - type
+- commerce
+  - color
+  - department
+  - productName
+  - price
+  - productAdjective
+  - productMaterial
+  - product
+  - productDescription
+- company
+  - suffixes
+  - companyName
+  - companySuffix
+  - catchPhrase
+  - bs
+  - catchPhraseAdjective
+  - catchPhraseDescriptor
+  - catchPhraseNoun
+  - bsAdjective
+  - bsBuzz
+  - bsNoun
+- database
+  - column
+  - type
+  - collation
+  - engine
+- datatype
+  - number
+  - float
+  - datetime
+  - string
+  - uuid
+  - boolean
+  - hexaDecimal
+  - json
+  - array
+- date
+  - past
+  - future
+  - between
+  - betweens
+  - recent
+  - soon
+  - month
+  - weekday
+- fake
+- finance
+  - account
+  - accountName
+  - routingNumber
+  - mask
+  - amount
+  - transactionType
+  - currencyCode
+  - currencyName
+  - currencySymbol
+  - bitcoinAddress
+  - litecoinAddress
+  - creditCardNumber
+  - creditCardCVV
+  - ethereumAddress
+  - iban
+  - bic
+  - transactionDescription
+- git
+  - branch
+  - commitEntry
+  - commitMessage
+  - commitSha
+  - shortSha
+- hacker
+  - abbreviation
+  - adjective
+  - noun
+  - verb
+  - ingverb
+  - phrase
+- helpers
+  - randomize
+  - slugify
+  - replaceSymbolWithNumber
+  - replaceSymbols
+  - replaceCreditCardSymbols
+  - repeatString
+  - regexpStyleStringParse
+  - shuffle
+  - mustache
+  - createCard
+  - contextualCard
+  - userCard
+  - createTransaction
+- image
+  - image
+  - avatar
+  - imageUrl
+  - abstract
+  - animals
+  - business
+  - cats
+  - city
+  - food
+  - nightlife
+  - fashion
+  - people
+  - nature
+  - sports
+  - technics
+  - transport
+  - dataUri
+  - lorempixel
+  - unsplash
+  - lorempicsum
+- internet
+  - avatar
+  - email
+  - exampleEmail
+  - userName
+  - protocol
+  - httpMethod
+  - url
+  - domainName
+  - domainSuffix
+  - domainWord
+  - ip
+  - ipv6
+  - port
+  - userAgent
+  - color
+  - mac
+  - password
+- lorem
+  - word
+  - words
+  - sentence
+  - slug
+  - sentences
+  - paragraph
+  - paragraphs
+  - text
+  - lines
+- mersenne
+  - rand
+  - seed
+  - seed_array
+- music
+  - genre
+- name
+  - firstName
+  - lastName
+  - middleName
+  - findName
+  - jobTitle
+  - gender
+  - prefix
+  - suffix
+  - title
+  - jobDescriptor
+  - jobArea
+  - jobType
+- phone
+  - phoneNumber
+  - phoneNumberFormat
+  - phoneFormats
+- system
+  - fileName
+  - commonFileName
+  - mimeType
+  - commonFileType
+  - commonFileExt
+  - fileType
+  - fileExt
+  - directoryPath
+  - filePath
+  - semver
+- time
+  - recent
+- unique
+- vehicle
+  - vehicle
+  - manufacturer
+  - model
+  - type
+  - fuel
+  - vin
+  - color
+  - vrm
+  - bicycle
 
 
 ### Faker.fake()
@@ -287,13 +288,12 @@ faker.js contains a super useful generator method `Faker.fake` for combining fak
 
 **Example:**
 
-
-``` js
-console.log(faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}"));
-// outputs: "Marks, Dean Sr."
+```js
+console.log(
+  faker.fake("{{name.lastName}}, {{name.firstName}} {{name.suffix}}")
+);
 ```
 
-
 This will interpolate the format string with the value of methods `name.lastName()`, `name.firstName()`, and `name.suffix()`
 
 ## Localization
@@ -309,65 +309,65 @@ Setting a new locale is simple:
 faker.locale = "de";
 ```
 
- * az
- * ar
- * cz
- * de
- * de_AT
- * de_CH
- * en
- * en_AU
- * en_AU_ocker
- * en_BORK
- * en_CA
- * en_GB
- * en_IE
- * en_IND
- * en_US
- * en_ZA
- * es
- * es_MX
- * fa
- * fi
- * fr
- * fr_CA
- * fr_CH
- * ge
- * hy
- * hr
- * id_ID
- * it
- * ja
- * ko
- * nb_NO
- * ne
- * nl
- * nl_BE
- * pl
- * pt_BR
- * pt_PT
- * ro
- * ru
- * sk
- * sv
- * tr
- * uk
- * vi
- * zh_CN
- * zh_TW
+ - az
+ - ar
+ - cz
+ - de
+ - de_AT
+ - de_CH
+ - en
+ - en_AU
+ - en_AU_ocker
+ - en_BORK
+ - en_CA
+ - en_GB
+ - en_IE
+ - en_IND
+ - en_US
+ - en_ZA
+ - es
+ - es_MX
+ - fa
+ - fi
+ - fr
+ - fr_CA
+ - fr_CH
+ - ge
+ - hy
+ - hr
+ - id_ID
+ - it
+ - ja
+ - ko
+ - nb_NO
+ - ne
+ - nl
+ - nl_BE
+ - pl
+ - pt_BR
+ - pt_PT
+ - ro
+ - ru
+ - sk
+ - sv
+ - tr
+ - uk
+ - vi
+ - zh_CN
+ - zh_TW
 
 
 ### Individual Localization Packages
 
 faker.js supports incremental loading of locales.
 
-By default, requiring `faker` will include *all* locale data.
+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');
+var faker = require("faker/locale/de");
 ```
 
 ## Setting a randomness seed
@@ -414,14 +414,6 @@ npm run browser
 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.