Skip to content

Commit 40fc057

Browse files
digitalghost-devdigitalghost-dev
committed
updating layout, adding card cmd reference
1 parent 76c2df9 commit 40fc057

File tree

1 file changed

+31
-22
lines changed

1 file changed

+31
-22
lines changed

‎README.md‎

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
<img src="https://img.shields.io/docker/image-size/digitalghostdev/poke-cli/v1.8.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>
8-
<div align="center">
9-
<img src="https://img.shields.io/coderabbit/prs/github/digitalghost-dev/poke-cli?style=flat-square&logo=coderabbit&logoColor=FF570A&labelColor=F6F6F1&color=FF570A" alt="coderabbit-review-count-badge">
10-
</div>
118
<div align="center">
129
<img src="https://img.shields.io/github/actions/workflow/status/digitalghost-dev/poke-cli/go_test.yml?style=flat-square&logo=go&logoColor=00ADD8&label=Tests&labelColor=EEE&color=00ADD8" alt="tests-label">
1310
<img src="https://img.shields.io/github/go-mod/go-version/digitalghost-dev/poke-cli?style=flat-square&logo=Go&labelColor=EEE&color=00ADD8" alt="go-version"/>
@@ -18,17 +15,21 @@
1815
`poke-cli` is a hybrid of a classic CLI and a modern TUI tool for viewing data about Pokémon! This is my first Go project.
1916
View the [documentation](https://docs.poke-cli.com)!
2017

21-
The architecture behind how the tool works is straight forward:
22-
1. Each command indicates which [API](https://pokeapi.co/) endpoint to use.
23-
2. Flags provide more information and can be stacked together or used individually.
24-
3. Each command has a `-h | --help` flag that is built-in with Golang's `flag` package.
25-
26-
View future plans in the [Roadmap](#roadmap) section.
18+
* [Demo](#demo)
19+
* [Installation](#installation)
20+
* [Usage](#usage)
21+
* [Roadmap](#roadmap)
22+
* [Tested Terminals](#tested-terminals)
2723

2824
---
2925
## Demo
30-
![demo](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/demo-v1.6.0.gif)
26+
### Video Game Data
27+
28+
![demo-vg](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/demo-v1.6.0.gif)
29+
30+
### Trading Card Game Data
3131

32+
![demo-tcg](https://poke-cli-s3-bucket.s3.us-west-2.amazonaws.com/poke-cli-v1.8.0.gif)
3233
---
3334
## Installation
3435

@@ -162,6 +163,7 @@ By running `poke-cli [-h | --help]`, it'll display information on how to use the
162163
│ COMMANDS: │
163164
│ ability Get details about an ability │
164165
│ berry Get details about a berry │
166+
│ card Get details about a TCG card │
165167
│ item Get details about an item │
166168
│ move Get details about a move │
167169
│ natures Get details about all natures │
@@ -187,6 +189,12 @@ Below is a list of the planned/completed commands and flags:
187189
- [x] `ability`: get data about an ability.
188190
- [x] `-p | --pokemon`: display Pokémon that learn this ability.
189191
- [x] `berry`: get data about a berry.
192+
- [ ] `card`: get data about a TCG card.
193+
- [x] add mega evolution data
194+
- [x] add scarlet & violet data
195+
- [ ] add sword & shield data
196+
- [ ] add sun & moon data
197+
- [ ] add x & y data
190198
- [x] `item`: get data about an item.
191199
- [x] `move`: get data about a move.
192200
- [ ] `-p | --pokemon`: display Pokémon that learn this move.
@@ -208,15 +216,16 @@ Below is a list of the planned/completed commands and flags:
208216

209217
---
210218
## Tested Terminals
211-
| Terminal | OS | Status | Issues |
212-
|-------------------|:-------------------------:|:------:|---------------------------------------------------------------------------------|
213-
| Alacritty | macOS, Ubuntu,<br>Windows | ✅ | None |
214-
| Ghostty | macOS | ✅ | None |
215-
| HyperJS | macOS | ✅ | None |
216-
| iTerm2 | macOS | ✅ | None |
217-
| Built-in Terminal | Ubuntu, Debian,<br>Fedora | ✅ | None |
218-
| Built-in Terminal | Alpine | ⚠️ | Some colors aren't supported.<br>`pokemon <name> --image=xx` flag pixel issues. |
219-
| Built-in Terminal | macOS | ⚠️ | `pokemon <name> --image=xx` flag pixel issues. |
220-
| Tabby | Ubuntu | ✅ | None |
221-
| WezTerm | macOS, Windows | ✅ | None |
222-
| Built-in Terminal | Windows | ✅ | None |
219+
| Terminal | OS | Status | Issues |
220+
|-------------------|:-------------------------:|:------:|-----------------------------------------------------------------------------------------------|
221+
| Alacritty | macOS, Ubuntu,<br>Windows | 🟡 | - Does not support sixel for TCG images. |
222+
| Ghostty | macOS | 🟡 | - Does not support sixel for TCG images. |
223+
| HyperJS | macOS | 🟡 | - Does not support sixel for TCG images. |
224+
| iTerm2 | macOS | ✅ | - None |
225+
| Built-in Terminal | Ubuntu, Debian,<br>Fedora | ✅ | - None |
226+
| Built-in Terminal | Alpine | 🟡 | - Some colors aren't supported.<br>- `pokemon <name> --image=xx` flag pixel issues. |
227+
| Built-in Terminal | macOS | 🟠 | - `pokemon <name> --image=xx` flag pixel issues.<br> - Does not support sixel for TCG images. |
228+
| Foot | Ubuntu | 🟢 | - None |
229+
| Tabby | Ubuntu | 🟢 | - None |
230+
| WezTerm | macOS, Windows | 🟢 | - None |
231+
| Built-in Terminal | Windows | 🟢 | - None |

0 commit comments

Comments
 (0)