diff --git a/README.md b/README.md index 4054c24..39bcdd0 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ It requires no third-party libraries. ## Usage + +### Command-line usage ```console usage: pokesummary [-h] [-i] [-s] [-v] [pokemon_names ...] @@ -26,6 +28,19 @@ optional arguments: -v, --version show program's version number and exit ``` +### Python library usage +Starting from version 2.0.0, you can use Pokésummary as a library. +Note that the API is subject to change. +```pycon +>>> from pokesummary.model import PokemonDict +>>> pokemon_data = PokemonDict().data +>>> my_pokemon = pokemon_data["Lanturn"] +>>> my_pokemon.base_stats.special_attack +76 +>>> my_pokemon.primary_type + +``` + ## Installation ### Requirements