mention pre-release labels in README.md

phar-io · Jun 23, 2018 · 872340c · 872340c
1 parent 3e41a7b
commit 872340c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -47,3 +47,15 @@ $tilde_constraint = $parser->parse( '~1.1.0' );
 $tilde_constraint->complies( new Version( '1.1.4' ) ); // true
 $tilde_constraint->complies( new Version( '1.2.0' ) ); // false
 ```
+
+As of version 2.0.0, pre-release labels are supported and taken into account when comparing versions:
+
+```php
+
+$leftVersion = new PharIo\Version\Version('3.0.0-alpha.1');
+$rightVersion = new PharIo\Version\Version('3.0.0-alpha.2');
+
+$leftVersion->isGreaterThan($rightVersion); // false
+$rightVersion->isGreaterThan($leftVersion); // true
+
+```