ericlay
/
fuzzy-pokedex
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Eric Lay 2023-04-24 19:47:00 -05:00 committed by GitHub
parent 54b5e15aa5
commit 190787ed6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,5 +1,6 @@
# Fuzzy-Pokedex # Fuzzy-Pokédex
Very simple fzf based pokedex I built for my son to enjoy ## The Pokédex for your terminal!
Very simple fzf based Pokédex I built for my son to enjoy
![Screenshot](https://github.com/ericlay/fuzzy-pokedex/blob/main/screenshot.png?raw=true) ![Screenshot](https://github.com/ericlay/fuzzy-pokedex/blob/main/screenshot.png?raw=true)
@ -14,9 +15,9 @@ EXAMPLE
OPTIONS OPTIONS
-q, --quick [pokemon] -q, --quick [pokemon]
Prints single pokedex entry to terminal Prints single Pokédex entry to terminal
-u, --update [N/+N/-N/N%] -u, --update [N/+N/-N/N%]
Scrape web for updated Pokemon stats Scrape web for updated Pokémon stats
WARNING: update function is resource heavy WARNING: update function is resource heavy
See Parallel job control (-j) for options See Parallel job control (-j) for options
Default is 200% Default is 200%
@ -25,20 +26,19 @@ OPTIONS
KEYBINDS KEYBINDS
space Reads the Pokedex entry space Reads the Pokedex entry
ctrl-space Stops reading the Pokedex entry ctrl-space Stops reading the Pokédex entry
ctrl-n Shows small sprite version ctrl-n Shows small sprite version
ctrl-b Shows large sprite version ctrl-b Shows large sprite version
ctrl-s Shows shiny sprite version ctrl-s Shows shiny sprite version
ctrl-h Shows this help screen in preview window ctrl-h Shows this help screen in preview window
``` ```
Credits to the great projects below in which do most the heavy lifting: \ Credits to the great projects below: \
https://gitlab.com/phoneybadger/pokemon-colorscripts \ https://gitlab.com/phoneybadger/pokemon-colorscripts \
https://github.com/rmccorm4/Pokefetch https://github.com/rmccorm4/Pokefetch
## To-do ## To-do
* [ ] Better arg parsing * [ ] Better arg parsing
* [ ] Rewrite to use `PokeAPI` as data source {Dev Branch 60%}
* [ ] Refactor to allow user to choose local data source or from web * [ ] Refactor to allow user to choose local data source or from web
* [ ] Get sprites from `PokeAPI` if possible {PR WELCOME!} * [ ] Get sprites from `PokeAPI` if possible {PR WELCOME!}
* [ ] Work on TTS to read entries * [ ] Work on TTS to read entries