Skip to content

Commit 5a06028

Browse files
committed
update README and description
1 parent d5ab5d7 commit 5a06028

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
# ZeroEntropy Python API library
1+
# ZeroEntropy Python SDK
22

33
[![PyPI version](https://img.shields.io/pypi/v/zeroentropy.svg)](https://pypi.org/project/zeroentropy/)
44

5-
The ZeroEntropy Python library provides convenient access to the ZeroEntropy REST API from any Python 3.8+
6-
application. The library includes type definitions for all request params and response fields,
7-
and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
5+
The ZeroEntropy Python SDK provides convenient access to the [ZeroEntropy REST API](https://docs.zeroentropy.dev/api-reference/) from any Python 3.8+
6+
application.
7+
8+
In order to get an API Key, you can visit our [dashboard](https://dashboard.zeroentropy.dev/).
89

910
## Documentation
1011

11-
The REST API documentation can be found on [docs.zeroentropy.dev](https://docs.zeroentropy.dev/api-reference). The full API of this library can be found in [api.md](api.md).
12+
The REST API documentation can be found on [docs.zeroentropy.dev](https://docs.zeroentropy.dev/api-reference). An introduction to how ZeroEntropy's API works can be found [here](https://docs.zeroentropy.dev/introduction).
13+
14+
The full API of the SDK can be found in [api.md](api.md). The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
1215

1316
## Installation
1417

1518
```sh
16-
# install from PyPI
17-
pip install --pre zeroentropy
19+
# Install from PyPI
20+
pip install zeroentropy
1821
```
1922

2023
## Usage

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "zeroentropy"
33
version = "0.1.0-alpha.2"
4-
description = "The official Python library for the zeroentropy API"
4+
description = "The official Python library for the ZeroEntropy API"
55
dynamic = ["readme"]
66
license = "Apache-2.0"
77
authors = [

0 commit comments

Comments
 (0)