Skip to content

Commit 253af5c

Browse files
author
root
committed
update docs and examples
1 parent e5931c8 commit 253af5c

File tree

1 file changed

+43
-10
lines changed

1 file changed

+43
-10
lines changed

README.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,42 @@
1+
<div align="center">
2+
13
# python-newtype
24

3-
[![PyPI version](https://badge.fury.io/py/python-newtype.svg)](https://badge.fury.io/py/python-newtype)
4-
[![Python Versions](https://img.shields.io/pypi/pyversions/python-newtype.svg)](https://pypi.org/project/python-newtype/)
5-
[![Documentation Status](https://readthedocs.org/projects/python-newtype/badge/?version=latest)](https://python-newtype.readthedocs.io/en/latest/?badge=latest)
6-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
## Documentation
6+
<a href="https://spyt.asyncmove.com">
7+
<img src="https://img.shields.io/badge/docs-passing-brightgreen.svg" width="100" alt="docs passing">
8+
</a>
9+
10+
### Compatibility and Version
11+
<img src="https://img.shields.io/badge/%3E=python-3.8-blue.svg" alt="Python compat">
12+
<a href="https://pypi.python.org/pypi/python-newtype-dev"><img src="https://img.shields.io/pypi/v/python-newtype-dev.svg" alt="PyPi"></a>
13+
14+
### CI/CD
15+
<a href="https://github.com/jymchng/python-newtype-dev/actions?query=workflow%3Atests"><img src="https://github.com/jymchng/python-newtype-dev/actions/workflows/tests.yaml/badge.svg?branch=main" alt="GHA Status"></a>
16+
<a href="https://codecov.io/github/jymchng/python-newtype-dev?branch=main"><img src="https://codecov.io/github/jymchng/python-newtype-dev/coverage.svg?branch=main" alt="Coverage"></a>
17+
18+
### License and Issues
19+
<a href="https://github.com/jymchng/python-newtype-dev/blob/main/LICENSE"><img src="https://img.shields.io/github/license/jymchng/python-newtype-dev" alt="License"></a>
20+
<a href="https://github.com/jymchng/python-newtype-dev/issues"><img src="https://img.shields.io/github/issues/jymchng/python-newtype-dev" alt="Issues"></a>
21+
<a href="https://github.com/jymchng/python-newtype-dev/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed/jymchng/python-newtype-dev" alt="Closed Issues"></a>
22+
<a href="https://github.com/jymchng/python-newtype-dev/issues?q=is%3Aissue+is%3Aopen"><img src="https://img.shields.io/github/issues-raw/jymchng/python-newtype-dev" alt="Open Issues"></a>
23+
24+
### Development and Quality
25+
<a href="https://github.com/jymchng/python-newtype-dev/network/members"><img src="https://img.shields.io/github/forks/jymchng/python-newtype-dev" alt="Forks"></a>
26+
<a href="https://github.com/jymchng/python-newtype-dev/stargazers"><img src="https://img.shields.io/github/stars/jymchng/python-newtype-dev" alt="Stars"></a>
27+
<a href="https://pypi.python.org/pypi/python-newtype-dev"><img src="https://img.shields.io/pypi/dm/python-newtype-dev" alt="Downloads"></a>
28+
<a href="https://github.com/jymchng/python-newtype-dev/graphs/contributors"><img src="https://img.shields.io/github/contributors/jymchng/python-newtype-dev" alt="Contributors"></a>
29+
<a href="https://github.com/jymchng/python-newtype-dev/commits/main"><img src="https://img.shields.io/github/commit-activity/m/jymchng/python-newtype-dev" alt="Commits"></a>
30+
<a href="https://github.com/jymchng/python-newtype-dev/commits/main"><img src="https://img.shields.io/github/last-commit/jymchng/python-newtype-dev" alt="Last Commit"></a>
31+
<a href="https://github.com/jymchng/python-newtype-dev"><img src="https://img.shields.io/github/languages/code-size/jymchng/python-newtype-dev" alt="Code Size"></a>
32+
<a href="https://github.com/jymchng/python-newtype-dev"><img src="https://img.shields.io/github/repo-size/jymchng/python-newtype-dev" alt="Repo Size"></a>
33+
<a href="https://github.com/jymchng/python-newtype-dev/watchers"><img src="https://img.shields.io/github/watchers/jymchng/python-newtype-dev" alt="Watchers"></a>
34+
<a href="https://github.com/jymchng/python-newtype-dev"><img src="https://img.shields.io/github/commit-activity/y/jymchng/python-newtype-dev" alt="Activity"></a>
35+
<a href="https://github.com/jymchng/python-newtype-dev/pulls"><img src="https://img.shields.io/github/issues-pr/jymchng/python-newtype-dev" alt="PRs"></a>
36+
<a href="https://github.com/jymchng/python-newtype-dev/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/jymchng/python-newtype-dev" alt="Merged PRs"></a>
37+
<a href="https://github.com/jymchng/python-newtype-dev/pulls?q=is%3Apr+is%3Aopen"><img src="https://img.shields.io/github/issues-pr/open/jymchng/python-newtype-dev" alt="Open PRs"></a>
38+
39+
</div>
740

841
A powerful Python library for extending existing types with additional functionality while preserving their original behavior, type information and subtype invariances.
942

@@ -49,13 +82,13 @@ print(text.split()) # ["Hello", "World"]
4982

5083
## Documentation
5184

52-
For detailed documentation, visit [python-newtype.readthedocs.io](https://python-newtype.readthedocs.io/).
85+
For detailed documentation, visit [py-nt.asyncmove.com](https://py-nt.asyncmove.com/).
5386

5487
### Key Topics:
55-
- [Installation Guide](https://python-newtype.readthedocs.io/en/latest/getting-started/installation/)
56-
- [Quick Start Guide](https://python-newtype.readthedocs.io/en/latest/getting-started/quickstart/)
57-
- [User Guide](https://python-newtype.readthedocs.io/en/latest/user-guide/basic-usage/)
58-
- [API Reference](https://python-newtype.readthedocs.io/en/latest/api/newtype/)
88+
- [Installation Guide](https://py-nt.asyncmove.com/getting-started/installation/)
89+
- [Quick Start Guide](https://py-nt.asyncmove.com/getting-started/quickstart/)
90+
- [User Guide](https://py-nt.asyncmove.com/user-guide/basic-usage/)
91+
- [API Reference](https://py-nt.asyncmove.com/api/newtype/)
5992

6093
## Development
6194

@@ -99,7 +132,7 @@ make test-custom
99132

100133
## Contributing
101134

102-
We welcome contributions! Please see our [Contributing Guide](https://python-newtype.readthedocs.io/en/latest/development/contributing/) for details.
135+
We welcome contributions! Please see our [Contributing Guide](https://py-nt.asyncmove.com/development/contributing/) for details.
103136

104137
## License
105138

0 commit comments

Comments
 (0)