mirrors/semver.lua
1
0
Fork 0
mirror of https://github.com/TangentFoxy/semver.lua.git synced 2025-07-28 02:52:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.textile

Browse Source
This commit is contained in:
Enrique García
2012-01-14 03:38:04 +01:00
parent 2229a189bd
commit 84fc954877
1 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
README.textile
View File

@@ -6,41 +6,41 @@ See http://semver.org/ for details about semantic versioning.
h1. Documentation h1. Documentation
``` lua <pre class="lua">
local v = require 'semver' local v = require 'semver'
-- accepts integers and numbers -- accepts integers and numbers
v1 = v(1,0,0) v1 = v(1,0,0)
v2_5_1 = v('2.5.1') v2_5_1 = v('2.5.1')
-- major, minor and patch attributes -- major, minor and patch attributes
v2_5_1.major -- 2 v2_5_1.major -- 2
v2_5_1.minor -- 5 v2_5_1.minor -- 5
v2_5_1.patch -- 1 v2_5_1.patch -- 1
-- also accepts prerelease/build parameters: -- also accepts prerelease/build parameters:
a = v(1,0,0,'-alpha') a = v(1,0,0,'-alpha')
a.prerelease -- 'alpha' a.prerelease -- 'alpha'
b = v'0.9.5+no.extensions.22' b = v'0.9.5+no.extensions.22'
b.build -- 'no.extensions.22' b.build -- 'no.extensions.22'
-- comparison & sorting -- comparison & sorting
v'1.2.3' == v(1,2,3) -- true v'1.2.3' == v(1,2,3) -- true
v'1.2.3' < v(4,5,6) -- true v'1.2.3' < v(4,5,6) -- true
-- "pessimistic upgrade" operator: ^ -- "pessimistic upgrade" operator: ^
-- a ^ b returns true if it's safe to update from a to b -- a ^ b returns true if it's safe to update from a to b
v'2.0.1' ^ v'2.5.1' -- true - it's safe to upgrade from 2.0.1 to 2.5.1 v'2.0.1' ^ v'2.5.1' -- true - it's safe to upgrade from 2.0.1 to 2.5.1
v'1.0.0' ^ v'2.0.0' -- false - 2.0.0 is not supposed to be backwards-compatible v'1.0.0' ^ v'2.0.0' -- false - 2.0.0 is not supposed to be backwards-compatible
v'2.5.1' ^ v'2.0.1' -- false - 2.5.1 is more modern than 2.0.1. v'2.5.1' ^ v'2.0.1' -- false - 2.5.1 is more modern than 2.0.1.
-- bumping -- bumping
v(1,0,0):nextPatch() -- v1.0.1 v(1,0,0):nextPatch() -- v1.0.1
v(1,2,3):nextMinor() -- v1.3.0 . Notice the patch resets to 0 v(1,2,3):nextMinor() -- v1.3.0 . Notice the patch resets to 0
v(1,2,3):nextMajor() -- v2.0.0 . Minor and patch are reset to 0 v(1,2,3):nextMajor() -- v2.0.0 . Minor and patch are reset to 0
``` </pre>
h1. Installation h1. Installation