Skip to content

Commit ceafb77

Browse files
Update docs
1 parent c959919 commit ceafb77

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,28 +20,30 @@ v123.isMinorRelease // false
2020
v123.isPatchRelease // true
2121

2222
// Parse semantic version from String
23-
let v200 = SemanticVersion("2.0.0-b1")!
23+
let v200 = SemanticVersion("2.0.0")!
2424
v200.isStable // true
2525
v200.isPreRelease // false
26-
v200.isMajorRelease // false
26+
v200.isMajorRelease // true
2727
v200.isMinorRelease // false
28-
v200.isPatchRelease // true
28+
v200.isPatchRelease // false
2929

3030
// Supports beta versions
31-
let v300 = SemanticVersion("3.0.0-rc1-test")!
32-
v300.isStable // false
33-
v300.isPreRelease // true
34-
v300.isMajorRelease // false
35-
v300.isMinorRelease // false
36-
v300.isPatchRelease // false
37-
v300.major // 3
38-
v300.minor // 0
39-
v300.patch // 0
40-
v300.preRelease // "rc1-test"
31+
let v300rc1 = SemanticVersion("3.0.0-rc1-test")!
32+
v300rc1.isStable // false
33+
v300rc1.isPreRelease // true
34+
v300rc1.isMajorRelease // false
35+
v300rc1.isMinorRelease // false
36+
v300rc1.isPatchRelease // false
37+
v300rc1.major // 3
38+
v300rc1.minor // 0
39+
v300rc1.patch // 0
40+
v300rc1.preRelease // "rc1-test"
4141

4242
// SemanticVersion is Comparable and Equatable
4343
v123 < v200 // true
44-
SemanticVersion("2.0.0")! < SemanticVersion("2.0.0-b1")! // true
44+
SemanticVersion("2.0.0")! < SemanticVersion("2.0.1")! // true
45+
// NB: beta versions ranke earlier than their releases
46+
SemanticVersion("2.0.0")! < SemanticVersion("2.0.0-b1")! // false
4547
v123 == SemanticVersion("1.2.3") // true
4648
SemanticVersion("v1.2.3-beta1+build5")
4749
== SemanticVersion(1, 2, 3, "beta1", "build5") // true
@@ -50,7 +52,7 @@ SemanticVersion("v1.2.3-beta1+build5")
5052
let dict = [ // [{major 3, minor 0, patch 0,...
5153
v123: 1,
5254
v200: 2,
53-
v300: 3
55+
v300rc1: 3
5456
]
5557

5658
// SemanticVersion is Codable

0 commit comments

Comments
 (0)