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-20 21:30:46 -05:00 committed by GitHub
parent cc36bf03c4
commit 1d6c844dfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -5,12 +5,38 @@ Very simple fzf based pokedex I built for my son to enjoy
Requires BeautifulSoup4, fzf, parallel, espeak-ng, pokemon-colorscipts and, any nerd font; all else should be there Requires BeautifulSoup4, fzf, parallel, espeak-ng, pokemon-colorscipts and, any nerd font; all else should be there
```
Use fzf to search Pokemon stats
Can optionally search by name
EXAMPLE
pokedex [pokemon name]
OPTIONS
-q, --quick [pokemon]
Prints single pokedex entry to terminal
-u, --update [N/+N/-N/N%]
Scrape web for updated Pokemon stats
WARNING: update function is resource heavy
See Parallel job control (-j) for options
Default is 200%
-h, --help
Print this help screen
KEYBINDS
space Reads the Pokedex entry
ctrl-space Stops reading the Pokedex entry
ctrl-n Shows small sprite version
ctrl-b Shows large sprite version
ctrl-s Shows shiny sprite version
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 in which do most the heavy lifting: \
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 * [ ] Rewrite to use `PokeAPI` as data source
* [ ] Refactor to allow user to choose local data source or from web * [ ] Refactor to allow user to choose local data source or from web