diff options
| author | Felix Morgner <felix.morgner@gmail.com> | 2019-12-28 15:49:49 +0100 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@gmail.com> | 2019-12-28 15:49:49 +0100 |
| commit | f5dd11b458ee4dc8eba3cc592cb4357bda3413a5 (patch) | |
| tree | d0a94c7f6e6d5d05bbe825614b883cf5adce3524 /README.rst | |
| parent | fe32c1470b4522ad876bd778fcf9ee0ef4c2b17e (diff) | |
| download | newtype-f5dd11b458ee4dc8eba3cc592cb4357bda3413a5.tar.xz newtype-f5dd11b458ee4dc8eba3cc592cb4357bda3413a5.zip | |
doc: add basic readme
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b769108 --- /dev/null +++ b/README.rst @@ -0,0 +1,24 @@ +======= +newtype +======= + +The `newtype` library provides types and functions to facilitate the creation of strong type aliases. + +.. image:: https://img.shields.io/badge/c%2B%2B-20-orange + +.. image:: https://img.shields.io/github/license/fmorgner/newtype + :alt: GitHub license + :target: https://github.com/fmorgner/newtype/blob/master/LICENSE + +.. image:: https://readthedocs.org/projects/newtype/badge/?version=latest + :target: https://newtype.readthedocs.io/?badge=latest + :alt: Documentation Status + +.. image:: https://img.shields.io/badge/Support-BTC-yellow + :alt: Support the project with Bitcoin + :target: bitcoin:14NhzUxmcXaXwLQQcj5UhDvSuxA6hmGkkg?label=Donation%20to%20%27fmorgner%2Fnew_type%27&message=Thanks%20for%20your%20work%20on%20%27fmorgner%2Fnewtype%27 + +Usage +===== + +Please `Read the Docs <https://newtype.rtfd.io>`_ for an introduction to the library.
\ No newline at end of file |