Skip to content

Commit

Permalink
docs: 📝 added updated usage in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zaghaghi committed Mar 16, 2024
1 parent f5850b6 commit 24f030f
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,31 @@

Terminal UI to list, browse and run APIs defined with OpenAPI v3.0 spec.


# Usage
```bash
❯ openapi-tui --help
This TUI allows you to list and browse APIs described by the openapi specification.

Usage: openapi-tui --input <PATH>

Options:
-i, --input <PATH> Input file or url, in json or yaml format with openapi specification
-h, --help Print help
-V, --version Print version
```

## Examples
```bash
# open local yaml file
❯ openapi-tui -i examples/stripe/spec.yml

# open local json file
❯ openapi-tui -i examples/petstore.json

# open remote file
❯ openapi-tui -i https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/api.github.com/api.github.com.yaml
```
# Demo
![demo](static/demo.gif)

Expand Down Expand Up @@ -85,20 +110,6 @@ Then, add `openapi-tui` to your `configuration.nix`
```


# Usage
```bash
❯ openapi-tui --help
This TUI allows you to list and browse APIs described by the openapi specification.

Usage: openapi-tui [OPTIONS]

Options:
-o, --openapi-path <PATH> Input file, i.e. json or yaml file with openapi specification [default:
openapi.json]
-h, --help Print help
-V, --version Print version
```

# Keybindings

| Key | Action|
Expand Down

0 comments on commit 24f030f

Please sign in to comment.