Skip to content

Commit

Permalink
docs: add installation instructions to top of README (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessicaSachs authored Jan 11, 2022
1 parent 78dc2ca commit d175aa1
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,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)
[![Continuous Integration](https://github.com/faker-js/faker/actions/workflows/ci.yml/badge.svg)](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).
Expand Down

0 comments on commit d175aa1

Please sign in to comment.