Skip to content

Commit

Permalink
updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
withtwoemms committed Feb 27, 2024
1 parent 4258238 commit 1fbda31
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Expand Up @@ -47,9 +47,21 @@ poetry run check

### Usage

There exists a `poetry` buildscript called `get-pokemon`.
It can be invoked like so:
There exists a `poetry` console script called `get-pokemon`.
It can be invoked like so (and optionally piped to `less`):

```
poetry run get-pokemon by --type ghost
```

Selection of `ApiRequest` implementation can be done using the `API_REQUEST_IMPL` environment variable:

```
API_REQUEST_IMPL=CACHED poetry run get-pokemon by --move razor-leaf
```

If you'd like to see the _actual_ API records instead of persistence metadata, use the `--view-records` flag:

```
API_REQUEST_IMPL=CACHED poetry run get-pokemon by --move razor-leaf --view-records
```

0 comments on commit 1fbda31

Please sign in to comment.