Add tests and credit Bulbapedia in README

This should resolve #2.
2022-10-24 20:31:29 -04:00
parent bc962bd419
commit d224776a9a
11 changed files with 24443 additions and 67 deletions
--- a/README.md
+++ b/README.md
@@ -5,8 +5,24 @@ to descriptions and pictures of the Pokemon within the e-book itself.

 It works with the epub that you can download from [Daystar Eld's Patreon](https://www.patreon.com/daystareld/).

+## Usage
+
 ```shell
+pip install --user pipenv
 pipenv install
 pipenv shell
 python ptoos-xray.py "DaystarEld - Pokemon The Origin of Species.epub"
 ```
+
+## Run tests
+
+```shell
+pipenv install --dev
+pipenv run pytest
+```
+
+## Credits
+
+Full credit for the Pokemon names, images, and descriptions goes to
+[Bulbapedia](https://bulbapedia.bulbagarden.net) under
+[Attribution-NonCommercial-ShareAlike 2.5](https://creativecommons.org/licenses/by-nc-sa/2.5/).