Skip to content

Commit 6bd4088

Browse files
adding better usage examples (#109)
1 parent b0caad1 commit 6bd4088

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -87,25 +87,29 @@ _If you have Go already, install the executable yourself_
8787
## Usage
8888
By running `poke-cli [-h | --help]`, it'll display information on how to use the tool.
8989
```
90-
╭─────────────────────────────────────────────────────────╮
91-
│Welcome! This tool displays data related to Pokémon! │
92-
│ │
93-
│ USAGE: │
94-
│ poke-cli [flag] │
95-
│ poke-cli <command> [flag] │
96-
│ poke-cli <command> <subcommand> [flag] │
97-
│ │
98-
│ FLAGS: │
99-
│ -h, --help Shows the help menu │
100-
│ -l, --latest Prints the latest version available │
101-
│ -v, --version Prints the current version │
102-
│ │
103-
│ COMMANDS: │
104-
│ ability Get details about an ability │
105-
│ natures Get details about Pokémon natures │
106-
│ pokemon Get details about a specific Pokémon │
107-
│ types Get details about a specific typing │
108-
╰─────────────────────────────────────────────────────────╯
90+
╭──────────────────────────────────────────────────────────╮
91+
│Welcome! This tool displays data related to Pokémon! │
92+
│ │
93+
│ USAGE: │
94+
│ poke-cli [flag] │
95+
│ poke-cli <command> [flag] │
96+
│ poke-cli <command> <subcommand> [flag] │
97+
│ │
98+
│ FLAGS: │
99+
│ -h, --help Shows the help menu │
100+
│ -l, --latest Prints the latest version available │
101+
│ -v, --version Prints the current version │
102+
│ │
103+
│ COMMANDS: │
104+
│ ability Get details about an ability │
105+
│ natures Get details about all natures │
106+
│ pokemon Get details about a Pokémon │
107+
│ types Get details about a typing │
108+
│ │
109+
│ hint: when calling a resource with a space, use a hyphen │
110+
│ example: poke-cli ability strong-jaw │
111+
│ example: poke-cli pokemon flutter-mane │
112+
╰──────────────────────────────────────────────────────────╯
109113
```
110114

111115
---

0 commit comments

Comments
 (0)