Skip to content

Commit 4e4defa

Browse files
committed
Updated readme
1 parent a7b98f6 commit 4e4defa

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
2-
3-
# go.bug.st/relaxed-semver [![build status](https://api.travis-ci.org/bugst/relaxed-semver.svg?branch=master)](https://travis-ci.org/bugst/relaxed-semver) [![codecov](https://codecov.io/gh/bugst/relaxed-semver/branch/master/graph/badge.svg)](https://codecov.io/gh/bugst/relaxed-semver)
1+
# go.bug.st/relaxed-semver [![build status](https://github.com/bugst/relaxed-semver/workflows/test/badge.svg)](https://travis-ci.org/bugst/relaxed-semver) [![codecov](https://codecov.io/gh/bugst/relaxed-semver/branch/master/graph/badge.svg)](https://codecov.io/gh/bugst/relaxed-semver)
42

53
A library for handling a superset of semantic versioning in golang.
64

@@ -12,9 +10,10 @@ See the godoc here: https://godoc.org/go.bug.st/relaxed-semver
1210

1311
This library tries to implement the semantic versioning specification [2.0.0](https://semver.org/spec/v2.0.0.html) with an exception: the numeric format `major.minor.patch` like `1.3.2` may be truncated if a number is zero, so:
1412

15-
- `1.2.0` or `1.2.0-beta` may be written as `1.2` or `1.2-beta` respectively
16-
- `1.0.0` or `1.0.0-beta` may be written `1` or `1-beta` respectively
17-
- `0.0.0` may be written as the **empty string**, but `0.0.0-beta` may **not** be written as `-beta`
13+
- `1.2.0` or `1.2.0-beta` may be written as `1.2` or `1.2-beta` respectively
14+
- `1.0.0` or `1.0.0-beta` may be written `1` or `1-beta` respectively
15+
- `0.0.0` may be written as the **empty string**, but `0.0.0-beta` may **not** be written as `-beta`
16+
1817
## Usage
1918

2019
You can parse a semver version string with the `Parse` function that returns a `Version` object that can be used to be compared with other `Version` objects using the `CompareTo`, `LessThan` , `LessThanOrEqual`, `Equal`, `GreaterThan` and `GreaterThanOrEqual` methods.
@@ -35,4 +34,4 @@ To parse a `RelaxedVersion` you can use the `ParseRelaxed` function.
3534

3635
## Json parsable
3736

38-
The `Version` and `RelaxedVersion` have the JSON un/marshaler implemented so they can be JSON decoded/encoded.
37+
The `Version` and `RelaxedVersion` have the JSON un/marshaler implemented so they can be JSON decoded/encoded.

0 commit comments

Comments
 (0)