Skip to content

Commit 99f9e03

Browse files
update readme
1 parent bfc6311 commit 99f9e03

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,19 @@
22

33
<h1 align="center">python-typeapi</h1>
44

5-
[PEP585]: https://peps.python.org/pep-0585/
6-
[PEP604]: https://peps.python.org/pep-0604/
75
[documentation]: https://niklasrosenstein.github.io/python-typeapi/
86

9-
The `typeapi` package provides a **unified and consistent** API for the reflection Python type hints from
10-
CPython 3.6.3 onwards. It also allows evaluating string-literal type annotations of more recent Python releases in
11-
older versions (such as [PEP585][] and [PEP604][] expressions).
7+
[![Documentation](https://img.shields.io/badge/Documentation-blue?style=flat&logo=gitbook&logoColor=white)](https://NiklasRosenstein.github.io/python-typeapi/)
8+
[![Python](https://github.com/NiklasRosenstein/python-typeapi/actions/workflows/python.yml/badge.svg)](https://github.com/NiklasRosenstein/python-typeapi/actions/workflows/python.yml)
129

13-
To learn more about this package, visit its [documentation][].
10+
The `typeapi` package provides a __unified and consistent API__ for the reflection and introspection of
11+
Python type hints. In addition, it allows evaluating future annotations such as
12+
[PEP585](https://peps.python.org/pep-0585/) (such as `list[str]`) and
13+
[PEP604](https://peps.python.org/pep-0604/) (such as `int | str`) in in versions that don't
14+
natively support them.
15+
16+
__Requirements__:
17+
18+
* Python 3.8 or newer
1419

1520
Please file bug reports and feature requests [on GitHub](https://github.com/NiklasRosenstein/python-typeapi/issues).

0 commit comments

Comments
 (0)