Skip to content

Commit

Permalink
update readme with api key info
Browse files Browse the repository at this point in the history
  • Loading branch information
martyndavies committed Aug 14, 2024
1 parent b84d92b commit d2ff0a1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,10 @@ npm install rmoa
rmoa lint --filename <openapi-filename> --api-key <API_KEY>
```

Source code & documentation at [packages/cli](/packages/cli/README.md)
Source code & documentation at [packages/cli](/packages/cli/README.md).

To get an `API_KEY` sign up for free at
[https://api.ratemyopenapi.com/docs](https://api.ratemyopenapi.com/docs).

### GitHub Action

Expand Down Expand Up @@ -152,6 +155,11 @@ To get started, go to
[https://api.ratemyopenapi.com/docs](https://api.ratemyopenapi.com/docs) to get
the detailed documentation on every endpoint available for use.

#### Getting an API key

To get an `API_KEY` you can sign up for free at
[https://api.ratemyopenapi.com/docs](https://api.ratemyopenapi.com/docs).

# License

[MIT License](./LICENSE)

0 comments on commit d2ff0a1

Please sign in to comment.