Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robzr committed Mar 7, 2024
1 parent 8aa340f commit 7500f09
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ can be even used as a function library in Busybox Dash/Ash.
- get or bump version identifiers (major, minor, patch, prerelease, build\_metadata)
- min/max/sort/filter lists of versions for valid versions with optional constraint matching
- version constraint evaluation using common constraint syntax with chaining (multiple constraints)
- precedence comparisons (sort/equals/greater\_than/less\_than/min/max) strictly implement SemVer spec (most SemVer sorts do not properly implement prerelease precedence comparisions)
- sort routine written with pure bash builtins with no subshells
- precedence comparisons (sort/equals/greater\_than/less\_than/min/max) strictly implement SemVer spec (most SemVer sorts do not properly implement prerelease precedence comparisons)
- sort routine written with pure bash builtins and uses no subshells
- deconstruct SemVer identifiers and output in json or yaml
- Bash command line completion function & injector built in
- uses Bash primitives & builtins exclusively for speed & portability, minimum subshells, no looped subshells
Expand All @@ -34,7 +34,7 @@ plugin repo.
```bash
asdf plugin add sver https://github.com/robzr/asdf-sver.git
asdf install sver latest
asdf global sver 1.2.0
asdf global sver latest
```

#### curl
Expand All @@ -53,6 +53,13 @@ If we can get enough momentum for this project on GitHub to meet Homebrew
criteria for a core formula, it will be added! This requires more than 75 stars,
30 forks or 30 watchers.

### Command line completion
Command completion is available for Bash users. Simply add the following to your
`~/.bashrc`:
```
. /dev/stdin <<< "$(sver complete)"
```

### Command line usage
See `sver help` for documentation.
```text
Expand Down

0 comments on commit 7500f09

Please sign in to comment.