diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..785ebca --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.emacs-project diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6dcb2b5 --- /dev/null +++ b/README.rst @@ -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