Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Aug 12, 2017
1 parent 3dd612c commit bd4d168
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ typepy
.. image:: https://img.shields.io/github/stars/thombashi/typepy.svg?style=social&label=Star
:target: https://github.com/thombashi/typepy


Summary
=======
A Python library for variable type checker/validator/converter at a run time.


Features
========
- checking a value type
Expand Down Expand Up @@ -47,6 +49,7 @@ The correspondence between Python types and ``typepy`` classes are as follows:
``str`` (IP address) `IpAddress <http://typepy.rtfd.io/en/latest/pages/reference/type.html#ip-address-type>`__
==================== =======================================================================================================


Usage
=====
Type Check Method
Expand Down Expand Up @@ -124,6 +127,7 @@ Type check/validate/convert results differed according to
``strict_level`` value which can pass to typepy classes constructors as an argument.
More information can be found in the
`API reference <http://typepy.rtfd.io/en/latest/pages/reference/index.html>`__.

Installation
============

Expand All @@ -146,6 +150,7 @@ Test dependencies
- `pytest-runner <https://pypi.python.org/pypi/pytest-runner>`__
- `tox <https://testrun.org/tox/latest/>`__


Documentation
=============
http://typepy.rtfd.io/

0 comments on commit bd4d168

Please sign in to comment.