add basic readme

This commit is contained in:
Kostya Rybnikov
2012-02-07 12:33:55 +02:00
parent 4c61dd002a
commit 93e01ec675
3 changed files with 22 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.emacs-project

0
README
View File

21
README.rst Normal file
View File

@@ -0,0 +1,21 @@
=================================================
Semver -- python module for semantic versioning
=================================================
Simple module for comparing versions as noted at `http://semver.org/`_.
This module provides just couple of functions, main of which are:
.. doctest::
>>> 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