Merge pull request #5 from zifter/codecheck

Prepare for first release

README.md

@@ -3,6 +3,16 @@ Convert from one numeric system to other in python.
 Supports following:
 * roman numerals
 
+# Example of usage
+```python
+>>> import numeral_system
+>>> numeral_system.roman.encode(7)
+'VII'
+>>> numeral_system.roman.decode('XXII')
+22
+>>>
+```
+
 [![Release](https://img.shields.io/github/release/zifter/numeral-system-py.svg)][releases-url]
 [![Code Coverage](https://codecov.io/gh/zifter/numeral-system-py/branch/master/graph/badge.svg)][codecov-url]
 [![Build status Appveyor](https://ci.appveyor.com/api/projects/status/github/zifter/numeral-system-py?branch=master&svg=true)][appveyor-url]

numeral_system/__init__.py

@@ -2,3 +2,13 @@
 Package which contains function for converting between different number system
 """
 __version__ = '0.1.0'
+
+
+from . import exceptions
+from . import roman
+
+
+__all__ = [
+    'exceptions',
+    'roman',
+]

setup.cfg

@@ -8,6 +8,7 @@ author-email = zifter.ai@gmail.com
 home-page = https://github.com/zifter/numeral-system-py
 description = attr: numeral_system.__doc__
 long-description = file: README.md
+long_description_content_type = text/markdown
 license = MIT
 license-file = LICENSE
 platform = any