Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update: Readme add API key info #273

Merged
merged 1 commit into from
Aug 14, 2024
Merged

Update: Readme add API key info #273

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
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)