mirror of
https://github.com/Steffo99/io-beep-boop.git
synced 2024-11-21 16:04:18 +00:00
🗒️ Create README
This commit is contained in:
parent
42ce7fa995
commit
ad5a579ae2
1 changed files with 16 additions and 15 deletions
31
README.md
31
README.md
|
@ -1,21 +1,22 @@
|
|||
# `io-beep-boop`
|
||||
|
||||
You should probably update this description to reflect your project :)
|
||||
An experimental wrapper and command line interface for the Italian [IO App API](https://developer.io.italia.it/openapi.html)
|
||||
|
||||
## Installation
|
||||
\[ [**Documentation**](https://io-beep-boop.readthedocs.io/en/latest/index.html) | [**PyPI**](https://pypi.org/project/io-beep-boop/) \]
|
||||
|
||||
```console
|
||||
$ pip install io-beep-boop
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```console
|
||||
$ io-beep-boop
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```console
|
||||
$ poetry install
|
||||
(.venv)$ io-beep-boop
|
||||
Usage: io-beep-boop [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
Options:
|
||||
--version Show the version and exit.
|
||||
-t, --token TEXT One of the two IO App API tokens of the service you want
|
||||
to use.
|
||||
--base-url TEXT The base URL of the IO App API to use.
|
||||
--help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
registered-fast
|
||||
registered-slow
|
||||
...
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue