Skip to content

docs: add installation instructions to top of README #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damienwebdev merged 2 commits into from
Jan 11, 2022
Merged

docs: add installation instructions to top of README #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
049b4cd
docs: add installation instructions to top of README
JessicaSachs Jan 11, 2022
019f0ed
docs: add Typescript Support instructions to README
JessicaSachs Jan 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,26 @@ Generate massive amounts of fake data in the browser and node.js.

[![Chat on Discord](https://img.shields.io/discord/929487054990110771)](https://discord.com/invite/4qDjAmDj4P)

## 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).
Expand Down