From ecbc372f7da0a9e6c7cc71251c956e1d22e881af Mon Sep 17 00:00:00 2001 From: Konstantine Rybnikov Date: Thu, 7 May 2015 15:14:27 +0300 Subject: [PATCH] Migrate README to markdown --- README.md | 22 ++++++++++++++++++++++ README.rst | 23 ----------------------- 2 files changed, 22 insertions(+), 23 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..de60d60 --- /dev/null +++ b/README.md @@ -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 +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index bb6b2f5..0000000 --- a/README.rst +++ /dev/null @@ -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 `_. - -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