From 93e01ec675c0809580148d99b4dcf6e68945e0a9 Mon Sep 17 00:00:00 2001 From: Kostya Rybnikov Date: Tue, 7 Feb 2012 12:33:55 +0200 Subject: [PATCH] add basic readme --- .gitignore | 1 + README | 0 README.rst | 21 +++++++++++++++++++++ 3 files changed, 22 insertions(+) create mode 100644 .gitignore delete mode 100644 README create mode 100644 README.rst 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