Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tmck-code committed Apr 25, 2024
1 parent 666834e commit 93dbe7d
Showing 1 changed file with 24 additions and 21 deletions.
45 changes: 24 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Print pokemon in the CLI! An adaptation of the classic "cowsay"
- [Full Usage](#full-usage)
- [Examples](#examples)
- [How it works](#how-it-works)
- [TODO](#todo)
- [Similar projects](#similar-projects)
- [TODO](#todo)

**Other docs**

Expand Down Expand Up @@ -171,26 +171,6 @@ easily popped into a directory in the user's `$PATH`
If all you are after is installing the program to use, then there are no dependencies required!
Navigate to the Releases and download the latest binary.
---
## TODO
- Short-term
- [ ] optionally print ID assigned to each pokemon, support deterministic selection via the same ID
- Longer-term
- In Beta
- [x] support long and short cli args (e.g. --name/-n)
- Completed
- [x] Make the category struct faster to load - currently takes up to 80% of the execution time
- [x] Store metadata and names in a more storage-efficient manner
- [x] Import japanese names from data/pokemon.json
- [x] Fix bad whitespace stripping when building assets
- [x] List all names
- [x] Make data structure to hold categories, names and pokemon
- [x] Increase speed
- [x] Improve categories to be more specific than shiny/regular
- [x] Filter by both name and category
## Similar projects
There are many other projects that bring pokemon to the terminal!
Expand All @@ -207,3 +187,26 @@ Inspired by the [pokeshell](https://github.com/acxz/pokeshell) project, I've inc
| [pokeTerm](https://github.com/31marcosalsa/pokeTerm) | python3 | ? | ? | ? | ? | ? | ? |
| [krabby](https://github.com/yannjor/krabby) | rust, cargo | ? ||||||
| [pokemonsay](https://github.com/dfrankland/pokemonsay) | npm | ? | ? | ? | ? | ? | ? |

---

## TODO

- **In progress**
- [ ] optionally print ID assigned to each pokemon, support deterministic selection via the same ID
- **Short-term**
- **Longer-term**
- [ ] make the process async.
- (Currently the searching/pokemon fetching is done _before_ any printing begins. There's an opportunity to start printing the speech bubble while also fetching the pokemon to print below it)
- **In Beta**
- [x] support long and short cli args (e.g. --name/-n)
- **Completed**
- [x] Make the category struct faster to load - currently takes up to 80% of the execution time
- [x] Store metadata and names in a more storage-efficient manner
- [x] Import japanese names from data/pokemon.json
- [x] Fix bad whitespace stripping when building assets
- [x] List all names
- [x] Make data structure to hold categories, names and pokemon
- [x] Increase speed
- [x] Improve categories to be more specific than shiny/regular
- [x] Filter by both name and category

0 comments on commit 93dbe7d

Please sign in to comment.