diff options
| author | Jess <[email protected]> | 2022-01-11 17:43:47 -0500 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-01-11 17:43:47 -0500 |
| commit | d175aa182b2ad9baef8ddc4d1ff7669addfa94a5 (patch) | |
| tree | 884b94420e06ac59d14bef8929f3ed59f5ed46c2 /README.md | |
| parent | 78dc2caa69d76665eaa22fc4ff16b2579a1ee827 (diff) | |
| download | faker-d175aa182b2ad9baef8ddc4d1ff7669addfa94a5.tar.xz faker-d175aa182b2ad9baef8ddc4d1ff7669addfa94a5.zip | |
docs: add installation instructions to top of README (#93)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -5,6 +5,26 @@ Generate massive amounts of fake data in the browser and node.js. [](https://discord.com/invite/4qDjAmDj4P) [](https://github.com/faker-js/faker/actions/workflows/ci.yml) +## Installation + +Please replace your `faker` dependency with `@faker-js/faker`. This is the official, stable fork of Faker. + +```shell +npm install @faker-js/faker -D +``` + +### Typescript Support + +Types are available via the `@types/faker` package. You must manually link them using a `*.d.ts` file, like so: + +```typescript +// faker.d.ts +declare module '@faker-js/faker' { + import faker from 'faker'; + export default faker; +} +``` + ## FAQ - What happened to the original faker.js? 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). |
