Skip to content

Commit

Permalink
docs: convert the usage to a quick start
Browse files Browse the repository at this point in the history
the oclif-generated usage docs felt messy — sort of repeating the info in the setup instructions but not really. this condenses that info and converts it to a quick start
  • Loading branch information
kanadgupta committed Dec 6, 2024
1 parent 826feca commit 3a007da
Showing 1 changed file with 28 additions and 35 deletions.
63 changes: 28 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,39 @@ npm run build && npm run build:docs
<!-- prettier-ignore-start -->
<!-- toc -->
* [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)
<!-- tocstop -->
<!-- prettier-ignore-end -->

# 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
Expand Down Expand Up @@ -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
Expand All @@ -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

<!--
This section is autogenerated using `oclif` and is regenerated with every release.
If you wish to preview these changes locally, run the following:
```
npm run build && npm run build:docs
```
-->

<!-- prettier-ignore-start -->
<!-- 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
...
```
<!-- usagestop -->
<!-- prettier-ignore-end -->

## Common `rdme` Options

- `--key <string>`: 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 <string>`: Your project version. See [our docs](https://docs.readme.com/docs/versions) for more information.

<!--
This section is autogenerated using `oclif` and is regenerated with every release.
Expand Down

0 comments on commit 3a007da

Please sign in to comment.