Skip to content

Commit

Permalink
Clarify usage in the README (#82)
Browse files Browse the repository at this point in the history
* Document fastify-overview dependency more explicitly

* Fix URL path

See: https://twitter.com/ManuEomm/status/1559492356898004995
  • Loading branch information
simonplend authored Aug 18, 2022
1 parent 1f86013 commit 906db49
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ To lean how to read the graph, please read the following documentation.

## Setup

This plugin requires `fastify-overview` to be installed
```bash
npm i fastify-overview fastify-overview-ui
```

- `npm i fastify-overview-ui`
Note: This plugin requires `fastify-overview` to be installed ([usage instructions](https://github.com/Eomm/fastify-overview#usage)).

## Usage

Expand All @@ -35,7 +37,7 @@ await fastify.register(require('fastify-overview'), {...})
await fastify.register(require('fastify-overview-ui'))
```

The UI will be available at `{your app's url}/fastify-overview-ui`
The UI will be available at `{your app's url}/fastify-overview-ui/`

## How to read the graph

Expand Down

0 comments on commit 906db49

Please sign in to comment.