Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinigami92 committed Jan 21, 2022
1 parent d7e7935 commit c528cb5
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -467,37 +467,43 @@ Faker uses [gulp](http://gulpjs.com/) to automate its build process. Each build
### Browser Bundle

```shell
npm run browser
pnpm install
pnpm run build
pnpm run browser
```

### Testing

```shell
npm install
npm run test
pnpm install
pnpm run build

pnpm run test
# or
pnpm run coverage
```

You can view a code coverage report generated in coverage/lcov-report/index.html.
You can view a code coverage report generated in `coverage/index.html`.

### Developing the docs

```shell
# build the Faker library for the browser
# it's used inside of certain routes
npm run browser
pnpm run browser

npm run docs:dev
pnpm run docs:dev
```

### Building and serving the docs statically

```shell
# build the Faker library for the browser
# it's used inside of certain routes
npm run browser
pnpm run browser

npm run docs:build # Output docs to /dist
npm run docs:serve # Serve docs from /dist
pnpm run docs:build # Output docs to /dist
pnpm run docs:serve # Serve docs from /dist
```

### Deploying Documentation
Expand Down

0 comments on commit c528cb5

Please sign in to comment.