Skip to content

Commit

Permalink
docs: fix formatting (#952)
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta authored Dec 20, 2023
1 parent 8e503fc commit 707ad1f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,9 @@ This command also has a dry run mode, which can be useful for initial setup and

If you run `rdme` within a directory that contains your OpenAPI or Swagger definition, you can omit the file path. `rdme` will then look for JSON or YAML files (including in sub-directories) that contain a top-level [`openapi`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields) or [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#fixed-fields) property.

> [!NOTE] `rdme` will not scan anything in the following:
> [!NOTE]
>
> `rdme` will not scan anything in the following:
>
> - Any `.git/` directories (if they exist)
> - Any files/directories specified in `.gitignore` files (including any `.gitignore` files in subdirectories, if they exist)
Expand Down

0 comments on commit 707ad1f

Please sign in to comment.