Skip to content

Commit 5bb9d4c

Browse files
committed
enhance readme
1 parent 833cd4c commit 5bb9d4c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,18 @@
66

77
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sindri-labs/sindri-python/build-publish-pypi.yml?style=for-the-badge)
88

9-
## Requirements
10-
- Python `>=3.8`
11-
129
## Description
1310
The Sindri Python SDK.
1411
Contains SDK code for Sindri APIs. Please see [sindri.app](https://sindri.app) for more details.
1512

13+
## Requirements
14+
This is compatible with Python `>=3.8`.
15+
However, Sindri does not officially support usage with Python versions that have passed their [End of Life](https://devguide.python.org/versions/) support.
16+
17+
## Installation
18+
You can install `sindri` from [PyPI](https://pypi.org/project/sindri/).
19+
For example: `pip install sindri`
20+
1621
## Documentation and Usage
1722
Documentation for this repo is automatically generated from the Python docstrings using [lazydocs](https://pypi.org/project/lazydocs/) and published to [sindri.app/docs/reference/sdk/](https://sindri.app/docs/reference/sdk/python) along with the rest of the documentation for Sindri.
1823
Docstrings for functions and methods follow the [google standard](https://google.github.io/styleguide/pyguide.html#383-functions-and-methods) for formatting.

0 commit comments

Comments
 (0)