From d2ff0a1436ec6bc132c35fbadbf51f3f0ca93abb Mon Sep 17 00:00:00 2001 From: Martyn Davies Date: Wed, 14 Aug 2024 16:19:17 +0200 Subject: [PATCH] update readme with api key info --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8002297..07486bc 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,10 @@ npm install rmoa rmoa lint --filename --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 @@ -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)