Skip to content

Commit 21095d3

Browse files
committed
docs: fix usage of "environment variable"
1 parent b422004 commit 21095d3

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,11 @@ For local CLI usage with a single project, you can authenticate `rdme` to your R
114114
> [!WARNING]
115115
> For security reasons, we strongly recommend providing a project API key via the `--key` option in automations or CI environments (GitHub Actions, CircleCI, Travis CI, etc.). It's also recommended if you're working with multiple ReadMe projects to avoid accidentally overwriting existing data.
116116
117-
You can also pass in your API key via environmental variable. Here is the order of precedence when passing your API key into `rdme`:
117+
You can also pass in your API key via environment variable. Here is the order of precedence when passing your API key into `rdme`:
118118

119119
1. The `--key` option. If that isn't present, we look for...
120-
1. The `RDME_API_KEY` environmental variable. If that isn't present, we look for...
121-
1. The `README_API_KEY` environmental variable. If that isn't present, we look for...
120+
1. The `RDME_API_KEY` environment variable. If that isn't present, we look for...
121+
1. The `README_API_KEY` environment variable. If that isn't present, we look for...
122122
1. The API key value stored in your local configuration file (i.e., the one set via `rdme login`)
123123

124124
`rdme whoami` is also available to you to determine who is logged in, and to what project. You can clear your stored credentials with `rdme logout`.
@@ -133,7 +133,7 @@ To set this up, check out [1Password's documentation on the ReadMe shell plugin]
133133

134134
## Proxy
135135

136-
`rdme` makes API requests to the ReadMe API, which is located at [dash.readme.com](https://dash.readme.com). If you need to configure a proxy for these requests, you can do so by setting the `HTTPS_PROXY` environmental variable.
136+
`rdme` makes API requests to the ReadMe API, which is located at [dash.readme.com](https://dash.readme.com). If you need to configure a proxy for these requests, you can do so by setting the `HTTPS_PROXY` environment variable.
137137

138138
```sh
139139
export HTTPS_PROXY=https://proxy.example.com:5678

documentation/synced/legacy/rdme.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ If you're working with the `docs` command specifically, we recommend using [dry
293293

294294
### Troubleshooting CLI
295295

296-
If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environmental variable to print helpful debugging info to the console:
296+
If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environment variable to print helpful debugging info to the console:
297297

298298
```sh
299299
DEBUG=rdme* rdme openapi validate [url-or-local-path-to-file]

documentation/synced/rdme.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ If you're working with the Markdown upload commands (e.g., `docs upload`, `refer
343343

344344
### Troubleshooting CLI
345345

346-
If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environmental variable to print helpful debugging info to the console:
346+
If you're troubleshooting issues with the CLI (or in some non-GitHub Actions environment), you can use the `DEBUG` environment variable to print helpful debugging info to the console:
347347

348348
```sh
349349
DEBUG=rdme* rdme openapi upload [url-or-local-path-to-file] --key=...

0 commit comments

Comments
 (0)