diff --git a/README.md b/README.md index 593371b..df785c5 100644 --- a/README.md +++ b/README.md @@ -20,21 +20,53 @@ Below is a short demo showcasing the main functionality of the program. [![asciicast](https://asciinema.org/a/499682.svg)](https://asciinema.org/a/499682) -## Usage - -You can use `present` from the command-line interface (CLI) or library. +## Installation -### CLI +`present` should run on any system, including Linux, MacOS, and the BSDs. -You can install the `present` command-line utility with the rust package manager -[cargo](https://github.com/rust-lang/cargo): +The easiest way to install it is by using [cargo](https://doc.rust-lang.org/cargo/index.html), +the Rust package manager: ```bash -$ cargo install present +cargo install present ``` -In addition, pre-built binaries can be found on the -[releases](https://github.com/terror/present/releases) page. +Otherwise, see below for the complete package list: + +#### Cross-platform + + + + + + + + + + + + + + + + + + + + + +
Package ManagerPackageCommand
Cargopresentcargo install present
Homebrewterror/tap/presentbrew install terror/tap/present
+ +### Pre-built binaries + +Pre-built binaries for Linux, MacOS, and Windows can be found on [the releases +page](https://github.com/terror/present/releases). + +## Usage + +You can use `present` from the command-line interface (CLI) or library. + +### CLI Below is the standard output of `present --help`, interpolated by the `present` binary itself!