diff --git a/README.md b/README.md index e8994d77e..771e275ff 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,39 @@ npm run build && npm run build:docs * [Table of Contents](#table-of-contents) +* [Quick Start](#quick-start) * [CLI Configuration](#cli-configuration) * [GitHub Actions Configuration](#github-actions-configuration) -* [Usage](#usage) * [Command Topics](#command-topics) +# Quick Start + +Install the CLI ([see here for more setup options](#setup)): + +```sh +npm install -g rdme +``` + +Validate an OpenAPI file in your working directory or any subdirectories ([see here for all command topics](#command-topics)): + +```sh +rdme openapi validate +``` + +Every command has a help page, which you can access in [our docs](./documentation/commands) or via the CLI: + +```sh +rdme openapi validate --help +``` + +To view the current version of `rdme` (helpful for troubleshooting and bug reports): + +```sh +rdme --version +``` + # CLI Configuration ## Setup @@ -124,7 +150,7 @@ rdme openapi > [!NOTE] > For a full GitHub Workflow file example and additional information on GitHub Actions usage, check out [our docs](https://docs.readme.com/docs/rdme#github-actions-usage). -For usage in [GitHub Actions](https://docs.github.com/actions), you can create a new GitHub Actions workflow file by including the `--github` flag with the command you wish to run in GitHub Actions. For example: +For usage in [GitHub Actions](https://docs.github.com/actions), you can create a new GitHub Actions workflow file by installing the CLI on your local machine and running the the command you wish to run in GitHub Actions, along with the `--github` flag. For example: ```sh rdme openapi --github @@ -134,39 +160,6 @@ This will run through the `openapi` command, ask you a few quick questions, and You can see examples featuring the latest version in [our docs](https://docs.readme.com/docs/rdme#github-actions-examples). We recommend [configuring Dependabot to keep your actions up-to-date](https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot). -# Usage - - - - - -```sh-session -$ npm install -g rdme -$ rdme COMMAND -running command... -$ rdme (--version) -rdme/9.0.0-next.35 linux-x64 node-v20.18.1 -$ rdme --help [COMMAND] -USAGE - $ rdme COMMAND -... -``` - - - -## Common `rdme` Options - -- `--key `: The API key associated with your ReadMe project. Note that most of the commands below require API key authentication, even though the `--key` flag is omitted from the examples. See the [Authentication](#authentication) section above for more information. -- `--version `: Your project version. See [our docs](https://docs.readme.com/docs/versions) for more information. -