Skip to content

Commit

Permalink
Normalize the README
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanTAllen committed May 10, 2020
1 parent e19d8b9 commit 5d50c11
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

A semantic versioning library and constraints solver for Ponylang heavily inspired by [blang/semver](https://github.com/blang/semver).

## Installation
## Status

[![Actions Status](https://github.com/ponylang/semver/workflows/vs-ponyc-latest/badge.svg)](https://github.com/ponylang/semver/actions)

Beta

## Installation

Expand All @@ -17,23 +21,4 @@ A semantic versioning library and constraints solver for Ponylang heavily inspir

## Usage

```pony
use "semver/version"
actor Main
new create(env: Env) =>
let v1 = Version(1, 2, 3)
let v2 = ParseVersion("1.2.4")
if (v2 > v1) then
// do something
end
let v3 = ParseVersion("1.2.3-1nv$l1d.prerel.f13ld$")
if (not v3.is_valid()) then
// do something
end
env.out.print(v1.string()) // => "1.2.3"
```

For usage of ranges / the solver see the test code for now.
See [examples](examples/) and the [ranges/solver](semver/test/) test code.

0 comments on commit 5d50c11

Please sign in to comment.