Update README.md

This commit is contained in:
Eric Lay 2023-04-29 14:22:06 -05:00 committed by GitHub
parent 52dbff60cf
commit 68e86f1055
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 2 deletions

View File

@ -1,11 +1,26 @@
# Fuzzy-Pokédex # Fuzzy-Pokédex
## The Pokédex for your terminal! ## The Pokédex for your terminal
Very simple fzf based Pokédex I built for my son to enjoy Simple fzf based Pokédex I built for my son to enjoy.
Parses results from [PokeAPI](pokeapi.co/) and feeds combined results from `pokemon-colorscripts` to `fzf`
![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)
A very wonky preview:
[![asciicast](https://asciinema.org/a/581487.svg)](https://asciinema.org/a/581487)
## Install
Requires fzf, parallel, jq, espeak-ng, pokemon-colorscipts and, any nerd font; all else should be there Requires fzf, parallel, jq, espeak-ng, pokemon-colorscipts and, any nerd font; all else should be there
### Arch (and arch based)
```
$ git clone https://github.com/ericlay/fuzzy-pokedex.git
$ cd fuzzy-pokedex
$ makepkg -si
```
## Usage
``` ```
Use fzf to search Pokemon stats Use fzf to search Pokemon stats
Can optionally search by name Can optionally search by name