Skip to content

Commit 3c2213d

Browse files
digitalghost-devdigitalghost-dev
committed
updating version numbers and usage, adding winget install
1 parent 508b69f commit 3c2213d

File tree

1 file changed

+48
-35
lines changed

1 file changed

+48
-35
lines changed

‎README.md‎

Lines changed: 48 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img height="250" width="350" src="pokemon.svg" alt="pokemon-logo"/>
33
<h1>Pokémon CLI</h1>
44
<img src="https://img.shields.io/github/v/release/digitalghost-dev/poke-cli?style=flat-square&logo=git&logoColor=FFCC00&label=Release%20Version&labelColor=EEE&color=FFCC00" alt="version-label">
5-
<img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.4.0?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
5+
<img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.5.0?arch=arm64&style=flat-square&logo=docker&logoColor=FFCC00&labelColor=EEE&color=FFCC00" alt="docker-image-size">
66
<img src="https://img.shields.io/github/actions/workflow/status/digitalghost-dev/poke-cli/ci.yml?branch=main&style=flat-square&logo=github&logoColor=FFCC00&label=CI&labelColor=EEE&color=FFCC00" alt="ci-status-badge">
77
</div>
88
<div align="center">
@@ -24,14 +24,15 @@ View future plans in the [Roadmap](#roadmap) section.
2424

2525
---
2626
## Demo
27-
![demo](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/demo-v1.3.3.gif)
27+
![demo](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/demo-v1.5.0.gif)
2828

2929
---
3030
## Installation
3131

3232
* [Binary](#binary)
3333
* [Docker Image](#docker-image)
3434
* [Homebrew](#homebrew)
35+
* [Winget](#winget)
3536
* [Source](#source)
3637

3738
### Binary
@@ -77,11 +78,11 @@ View future plans in the [Roadmap](#roadmap) section.
7778
3. Choose how to interact with the container:
7879
* Run a single command and exit:
7980
```bash
80-
docker run --rm -it digitalghostdev/poke-cli:v1.4.0 <command> [subcommand] flag]
81+
docker run --rm -it digitalghostdev/poke-cli:v1.5.0 <command> [subcommand] flag]
8182
```
8283
* Enter the container and use its shell:
8384
```bash
84-
docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.4.0 -c "cd /app && exec sh"
85+
docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.5.0 -c "cd /app && exec sh"
8586
# placed into the /app directory, run the program with './poke-cli'
8687
# example: ./poke-cli ability swift-swim
8788
```
@@ -91,7 +92,18 @@ View future plans in the [Roadmap](#roadmap) section.
9192
```bash
9293
brew install --cask digitalghost-dev/tap/poke-cli
9394
````
94-
2. Verify install!
95+
2. Verify install:
96+
```bash
97+
poke-cli -v
98+
```
99+
100+
### Winget
101+
1. Install the package:
102+
```powershell
103+
winget install poke-cli
104+
```
105+
106+
2. Verify install:
95107
```bash
96108
poke-cli -v
97109
```
@@ -108,35 +120,36 @@ View future plans in the [Roadmap](#roadmap) section.
108120
## Usage
109121
By running `poke-cli [-h | --help]`, it'll display information on how to use the tool.
110122
```
111-
╭──────────────────────────────────────────────────────────╮
112-
│Welcome! This tool displays data related to Pokémon! │
113-
│ │
114-
│ USAGE: │
115-
│ poke-cli [flag] │
116-
│ poke-cli <command> [flag] │
117-
│ poke-cli <command> <subcommand> [flag] │
118-
│ │
119-
│ FLAGS: │
120-
│ -h, --help Shows the help menu │
121-
│ -l, --latest Prints the latest version available │
122-
│ -v, --version Prints the current version │
123-
│ │
124-
│ COMMANDS: │
125-
│ ability Get details about an ability │
126-
│ item Get details about an item │
127-
│ move Get details about a move │
128-
│ natures Get details about all natures │
129-
│ pokemon Get details about a Pokémon │
130-
│ search Search for a resource │
131-
│ types Get details about a typing │
132-
│ │
133-
│ hint: when calling a resource with a space, use a hyphen │
134-
│ example: poke-cli ability strong-jaw │
135-
│ example: poke-cli pokemon flutter-mane │
136-
│ │
137-
│ ↓ ctrl/cmd + click for docs/guides │
138-
│ docs.poke-cli.com │
139-
╰──────────────────────────────────────────────────────────╯
123+
╭───────────────────────────────────────────────────────────────╮
124+
│Welcome! This tool displays data related to Pokémon! │
125+
│ │
126+
│ USAGE: │
127+
│ poke-cli [flag] │
128+
│ poke-cli <command> [flag] │
129+
│ poke-cli <command> <subcommand> [flag] │
130+
│ │
131+
│ FLAGS: │
132+
│ -h, --help Shows the help menu │
133+
│ -l, --latest Prints the latest version available │
134+
│ -v, --version Prints the current version │
135+
│ │
136+
│ COMMANDS: │
137+
│ ability Get details about an ability │
138+
│ item Get details about an item │
139+
│ move Get details about a move │
140+
│ natures Get details about all natures │
141+
│ pokemon Get details about a Pokémon │
142+
│ search Search for a resource │
143+
│ speed Calculate the speed of a Pokémon in battle │
144+
│ types Get details about a typing │
145+
│ │
146+
│ hint: when calling a resource with a space, use a hyphen │
147+
│ example: poke-cli ability strong-jaw │
148+
│ example: poke-cli pokemon flutter-mane │
149+
│ │
150+
│ ↓ ctrl/cmd + click for docs/guides │
151+
│ docs.poke-cli.com │
152+
╰───────────────────────────────────────────────────────────────╯
140153
```
141154
142155
---
@@ -163,7 +176,7 @@ Below is a list of the planned/completed commands and flags:
163176
- [ ] `item`
164177
- [x] `move`
165178
- [x] `pokemon`
166-
- [ ] `speed`: compare speed stats between two Pokémon.
179+
- [x] `speed`: compare speed stats between two Pokémon.
167180
- [x] `types`: get data about a specific typing.
168181

169182
---

0 commit comments

Comments
 (0)