diff --git a/README.md b/README.md index f1e74b4b174ce653d98a964e783238ffb849f64f..dac36b376071e124b09afbeb83003eb74a6c7087 100644 --- a/README.md +++ b/README.md @@ -80,12 +80,28 @@ Black, the formatting tool, requires Python 3.6 or higher. poetry install --no-dev ``` -* Have a look at the examples folder -* Run examples from parent folder +### Examples +* Have a look at the `examples` folder +* Run examples from parent folder directly ```bash poetry run python examples/request_data.py ``` +Or from Python interpreter: +```bash +poetry run python +>>> import examples +>>> help(examples) +>>> examples.create_public_key() +``` + +`request_data_async` requires [`aioconsole`](https://pypi.org/project/aioconsole/): +```bash +poetry add aioconsole --dev +poetry run apython +await examples.request_data_async() +``` + * Before submitting a merge requests, please check the static typing and tests. * Install dev dependencies