summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorRaphaël Barrois <raphael.barrois@polytechnique.org>2019-08-23 23:24:50 +0200
committerRaphaël Barrois <raphael.barrois@polytechnique.org>2019-08-26 21:34:10 +0200
commitc4c6ab0e925d8cfabb68d34a10a783cb854b63a0 (patch)
tree84895b9dd586594c380668875ede00ba4b8a928a /README.rst
parent5b9174aedaf9843ee5b3b6358461910e328e74d1 (diff)
downloadsemantic-version-c4c6ab0e925d8cfabb68d34a10a783cb854b63a0.tar.gz
Add support for NPM-style version ranges.
The code follows closely the specification available at https://docs.npmjs.com/misc/semver.html. Despite similarities, the matching logic is fully separate from the `native` code, since both might evolve at their own scales.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 0d0d421..257b2a4 100644
--- a/README.rst
+++ b/README.rst
@@ -280,6 +280,22 @@ build metadata is equality.
False
+NPM-based ranges
+----------------
+
+The :class:`NpmSpec` class handles NPM-style ranges:
+
+.. code-block:: pycon
+
+ >>> Version('1.2.3') in NpmSpec('1.2.2 - 1.4')
+ True
+ >>> Version('1.2.3') in NpmSpec('<1.x || >=1.2.3')
+ True
+
+Refer to https://docs.npmjs.com/misc/semver.html for a detailed description of NPM
+range syntax.
+
+
Using with Django
=================