Skip to content
This repository has been archived by the owner on Dec 13, 2021. It is now read-only.

Commit

Permalink
Merge pull request #53 from nickgerace/dev
Browse files Browse the repository at this point in the history
Add upgrade step for cargo install to README
  • Loading branch information
nickgerace committed Sep 10, 2021
2 parents b63088f + 7a05848 commit d0cbcc4
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 28 deletions.
File renamed without changes.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,27 @@ Customize your Docker installation to your liking since `bovine` does not requir

## Installation

`bovine` is designed to work on any tier one Rust platform that can interface with Docker.
You can install and [upgrade](./docs/EXTRA.md) the application by using `cargo`.
There are two primary methods for installing `bovine`.

### Cargo (recommended)

`bovine` is designed to work on any tier one Rust platform with access to the Docker daemon.
You can install and upgrade the application by using `cargo`.

```sh
cargo install bovine
```

You can install `cargo` via [rustup](https://rustup.rs/) (recommended) or your preferred package manager.
Keeping the crate up to date is easy with [cargo-update](https://crates.io/crates/cargo-update).

```sh
cargo install cargo-update
cargo install-update -a
```

`cargo` can be installed with [rustup](https://rustup.rs/) (recommended) or your preferred package manager.

### Binary from Release

If you do not want to install `cargo`, you can download a binary from the [releases page](https://github.com/nickgerace/bovine/releases).
The following convenience script can be used on macOS and Linux `amd64` systems (requires `wget`, `jq`, and `curl` to be installed):
Expand Down
3 changes: 2 additions & 1 deletion docs/RELEASE.md → RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ This checklist details the `bovine` release process.

- [ ] Checkout (or create a branch of) `main` at its latest commit.
- [ ] Change the `version` field in `Cargo.toml` to `$NEW_TAG`.
- [ ] Run `make release` and verify that everything looks/works as expected.
- [ ] (Skip for release candidates) change the version in `CHANGELOG.md` and uncomment the line, `<!--The latest version contains all changes.-->`.
- [ ] Run `make release` and verify that everything looks/works as expected.
- [ ] Create a commit with the following message: `Update to $NEW_TAG`. Do not push (or merge) the commit.
- [ ] Test and verify the publishing workflow: `cargo publish --dry-run`.
- [ ] Finally, push (or merge) the preparation commit into `main`.
Expand All @@ -25,4 +25,5 @@ This checklist details the `bovine` release process.
### Post Release

- [ ] Check the [crate](https://crates.io/crates/bovine) on `crates.io`.
- [ ] Download the crate via `cargo install bovine` or `cargo install --version <tag> bovine`
- [ ] Check the [release](https://github.com/nickgerace/bovine/releases) on the repository's releases page.
24 changes: 0 additions & 24 deletions docs/EXTRA.md

This file was deleted.

0 comments on commit d0cbcc4

Please sign in to comment.