diff --git a/README.md b/README.md index 32fb634..c64480d 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,20 @@ … or: "apt-spy for Ubuntu" [![pr](https://github.com/lagged/apt-spy2/actions/workflows/pr.yml/badge.svg)](https://github.com/lagged/apt-spy2/actions/workflows/pr.yml) -[![Gem Version](https://badge.fury.io/rb/apt-spy2.svg)](https://badge.fury.io/rb/apt-spy2) +![apt-spy2 (including prereleases)](https://img.shields.io/gem/v/apt-spy2?include_prereleases) [![Code Climate](https://codeclimate.com/github/lagged/apt-spy2.png)](https://codeclimate.com/github/lagged/apt-spy2) [![Coverage Status](https://coveralls.io/repos/lagged/apt-spy2/badge.png)](https://coveralls.io/r/lagged/apt-spy2) ## Installation -``` +```sh gem install apt-spy2 ``` ## Usage -``` +```sh $ apt-spy2 [21:03:52] apt-spy2 commands: apt-spy2 check # Evaluate mirrors @@ -30,14 +30,14 @@ apt-spy2 commands: Displays a list of currently available mirrors. These mirrors are automatically selected via [ubuntu-mirrors](http://mirrors.ubuntu.com) using your IP's location. -``` +```sh $ apt-spy2 list ... ``` Since `mirrors.ubuntu.com` is frequently down, you can the list on [Launchpad](launchpad.net/ubuntu/+archivemirrors): -``` +```sh $ apt-spy2 list --launchpad --country=Germany ... ``` @@ -46,7 +46,7 @@ $ apt-spy2 list --launchpad --country=Germany `check` works like `list`, but also determines if the servers returned are working. It supports the flag `--launchpad` as well and additionally a flag `--strict` which checks if a mirror carries a certain release and distribution. -``` +```sh $ apt-spy2 check ... $ apt-spy2 check --launchpad --country=US @@ -70,10 +70,10 @@ See `apt-spy2 help list|check|fix` for available options. ### exit codes - * 0 - all went well - * 1 - some kind of error +* 0 - all went well +* 1 - some kind of error -### output and non-interactiveness +### output and non-interactive behavior See `apt-spy2 help COMMAND` for more information. @@ -85,6 +85,6 @@ Generally, `apt-spy2` plays especially nice in a non-interactive environment and ### Release (procedure) - - update version in `lib/apt/spy2/version.rb` - - `bundle install` - - `git commit -a -m 'New release' && git tag -a vVERSION && git push --tags` +* update version in `lib/apt/spy2/version.rb` +* `bundle install` +* `git commit -a -m 'New release' && git tag -a vVERSION && git push --tags`