Migrate README to markdown

This commit is contained in:
Konstantine Rybnikov
2015-05-07 15:14:27 +03:00
parent e7ab901ed7
commit ecbc372f7d
2 changed files with 22 additions and 23 deletions

22
README.md Normal file
View File

@@ -0,0 +1,22 @@
Semver -- python module for semantic versioning
===============================================
![Travis CI](https://travis-ci.org/k-bx/python-semver.svg?branch=master)
Simple module for comparing versions as noted at [semver.org](http://semver.org/).
This module provides just couple of functions, main of which are:
```python
>>> import semver
>>> semver.compare("1.0.0", "2.0.0")
-1
>>> semver.compare("2.0.0", "1.0.0")
1
>>> semver.compare("2.0.0", "2.0.0")
0
>>> semver.match("2.0.0", ">=1.0.0")
True
>>> semver.match("1.0.0", ">1.0.0")
False
```

View File

@@ -1,23 +0,0 @@
=================================================
Semver -- python module for semantic versioning
=================================================
.. image:: https://travis-ci.org/k-bx/python-semver.svg?branch=master
Simple module for comparing versions as noted at
`semver.org <http://semver.org/>`_.
This module provides just couple of functions, main of which are:
..
>>> import semver
>>> semver.compare("1.0.0", "2.0.0")
-1
>>> semver.compare("2.0.0", "1.0.0")
1
>>> semver.compare("2.0.0", "2.0.0")
0
>>> semver.match("2.0.0", ">=1.0.0")
True
>>> semver.match("1.0.0", ">1.0.0")
False