Skip to content

Commit c9534cb

Browse files
updating version numbers and tested terminals
1 parent 98b06f8 commit c9534cb

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 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.5.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.1?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,7 +24,7 @@ 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.5.0.gif)
27+
![demo](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/demo-v1.5.1.gif)
2828

2929
---
3030
## Installation
@@ -78,11 +78,11 @@ View future plans in the [Roadmap](#roadmap) section.
7878
3. Choose how to interact with the container:
7979
* Run a single command and exit:
8080
```bash
81-
docker run --rm -it digitalghostdev/poke-cli:v1.5.0 <command> [subcommand] flag]
81+
docker run --rm -it digitalghostdev/poke-cli:v1.5.1 <command> [subcommand] flag]
8282
```
8383
* Enter the container and use its shell:
8484
```bash
85-
docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.5.0 -c "cd /app && exec sh"
85+
docker run --rm -it --name poke-cli --entrypoint /bin/sh digitalghostdev/poke-cli:v1.5.1 -c "cd /app && exec sh"
8686
# placed into the /app directory, run the program with './poke-cli'
8787
# example: ./poke-cli ability swift-swim
8888
```
@@ -118,7 +118,7 @@ View future plans in the [Roadmap](#roadmap) section.
118118

119119
---
120120
## Usage
121-
By running `poke-cli [-h | --help]`, it'll display information on how to use the tool.
121+
By running `poke-cli [-h | --help]`, it'll display information on how to use the tool or check out the [docs](https://docs.poke-cli.com/)!
122122
```
123123
╭───────────────────────────────────────────────────────────────╮
124124
│Welcome! This tool displays data related to Pokémon! │
@@ -166,9 +166,9 @@ Below is a list of the planned/completed commands and flags:
166166
- [x] `natures`: get data about natures.
167167
- [x] `pokemon`: get data about a Pokémon.
168168
- [x] `-a | --abilities`: display the Pokémon's abilities.
169+
- [ ] `-d | --defense`: display the Pokémon's type defences.
169170
- [x] `-i | --image`: display a pixel image of the Pokémon.
170171
- [x] `-s | --stats`: display the Pokémon's base stats.
171-
- [x] `-t | --types`: display the Pokémon's typing.
172172
- [x] `-m | --moves`: display learnable moves.
173173
- [ ] `search`: search for a resource
174174
- [x] `ability`
@@ -181,13 +181,14 @@ Below is a list of the planned/completed commands and flags:
181181

182182
---
183183
## Tested Terminals
184-
| OS | Terminal | Status | Issues |
185-
|---------|-------------------|:------:|-------------------------------|
186-
| macOS | Ghostty || None |
187-
| macOS | Alacritty || None |
188-
| macOS | HyperJS || None |
189-
| macOS | iTerm2 || None |
190-
| macOS | macOS Terminal | ⚠️ | Images do not render properly |
191-
| Windows | Windows Terminal || None |
192-
| Ubuntu | Standard Terminal || None |
193-
| Ubuntu | Tabby || None |
184+
| Terminal | OS | Status | Issues |
185+
|------------------|:-------------------------:|:------:|-----------------------------------------|
186+
| Alacritty | macOS, Ubuntu,<br>Windows || None |
187+
| Ghostty | macOS || None |
188+
| HyperJS | macOS || None |
189+
| iTerm2 | macOS || None |
190+
| Linux Terminal | Ubuntu || None |
191+
| macOS Terminal | macOS | ⚠️ | `pokemon [name] --image=xx` flag issues |
192+
| Tabby | Ubuntu || None |
193+
| WezTerm | macOS, Windows || None |
194+
| Windows Terminal | Windows || None |

0 commit comments

Comments
 (0)