aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: b01ee4e93c081edeff0253571ad8d0f1bfbc2c61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
=======
newtype
=======

The `newtype` library provides types and functions to facilitate the creation of strong type aliases.

|c++20| |license| |docs| |travis| |btc|

Usage
=====

Please `Read the Docs <https://newtype.rtfd.io>`_ for an introduction to the library.

.. |c++20| image:: https://img.shields.io/badge/c%2B%2B-20-orange
   :alt: C++20
   :target: https://en.wikipedia.org/wiki/C%2B%2B20

.. |license| image:: https://img.shields.io/github/license/fmorgner/newtype
   :alt: GitHub license
   :target: https://github.com/fmorgner/newtype/blob/master/LICENSE
   
.. |docs| image:: https://readthedocs.org/projects/newtype/badge/?version=latest
   :target: https://newtype.readthedocs.io/?badge=latest
   :alt: Documentation Status
   
.. |btc| 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

.. |travis| image:: https://travis-ci.org/fmorgner/newtype.svg?branch=master
    :target: https://travis-ci.org/fmorgner/newtype