diff --git a/README.md b/README.md index ac8c6807a6f..14461fabecd 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,7 @@ pnpm install @faker-js/faker -D ```js const { faker } = require('@faker-js/faker'); + const randomName = faker.name.findName(); // Rowan Nikolaus const randomEmail = faker.internet.email(); // Kassandra.Haley@erich.biz const randomPhoneNumber = faker.phone.phoneNumber(); // (279) 329-8663 x30233 @@ -95,6 +96,12 @@ In order to have faker working properly, you need to check if these `compilerOpt } ``` +And then simply import it like everything else: + +```ts +import { faker } from '@faker-js/faker'; +``` + If you want for whatever reason the versions prior to `v6`, you can use `@types/faker` and rebind the declarations to the `@faker-js/faker` package with a `faker.d.ts` file in your e.g. src folder.