From 0d370fa7deb0a9915c56626e0ae2bd8bf8cf94d3 Mon Sep 17 00:00:00 2001 From: Caleb Bassi Date: Thu, 23 Jan 2020 07:13:51 -0800 Subject: [PATCH] update readme and changelog --- CHANGELOG.md | 4 ++++ README.md | 23 +++++++++++++++-------- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bb401a..172f8cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- Add preliminary macOS support + ## [0.2.0] - 2020-01-20 ### Added diff --git a/README.md b/README.md index c3ae665..26e5b63 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,16 @@ ## Missing features -- Only works on Linux +- macOS is missing temperatures, disks, and process commandline - Process filtering isn't implemented - Mouse usage isn't implemented - `rate` and `interfaces` cli args aren't implemented ## Installation -Currently only working on Linux with support planned for all major platforms. +Currently working on Linux and macOS with support planned for all major platforms. -### Prebuilt binaries: +### Prebuilt binaries Run the following to run [this](https://github.com/japaric/trust/blob/gh-pages/install.sh) script to download the correct binary for your system from the releases tab into `~/.cargo/bin`, courtesy of [japaric/trust](https://github.com/japaric/trust): @@ -34,7 +34,18 @@ bash <(curl -LSfs https://japaric.github.io/trust/install.sh) \ Specify `--to` to change the download location. -### From source: +### Arch Linux + +Install `ytop`, `ytop-bin`, or `ytop-git` from the AUR. + +### Homebrew + +```bash +brew tap cjbassi/ytop +brew install ytop +``` + +### From source Latest release: @@ -48,10 +59,6 @@ Latest commit: cargo install -f --git https://github.com/cjbassi/ytop ``` -### Arch Linux - -Install `ytop`, `ytop-bin`, or `ytop-git` from the AUR. - ## Usage ### Keybinds