From 1237a35663559d5088ccdd541f15e4dadadd5d64 Mon Sep 17 00:00:00 2001 From: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> Date: Wed, 19 Jan 2022 20:49:11 -0800 Subject: [PATCH] docs: update app descriptions (#659) Update app descriptions across the board to be more consistent. --- Cargo.toml | 6 +++--- README.md | 2 +- deployment/windows/choco/bottom.nuspec.template | 4 ++-- docs/mkdocs.yml | 6 +----- 4 files changed, 7 insertions(+), 11 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index ce0f843f..ff6a4a2f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,7 +7,8 @@ repository = "https://github.com/ClementTsang/bottom" keywords = ["cross-platform", "monitoring", "cli", "top", "tui"] license = "MIT" categories = ["command-line-utilities", "visualization"] -description = "A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows." +description = "A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows." +documentation = "https://clementtsang.github.io/bottom/stable" readme = "README.md" default-run = "btm" build = "build.rs" @@ -104,8 +105,7 @@ assets = [ ["completion/_btm", "usr/share/zsh/vendor-completions/", "644"], ] extended-description = """\ -A cross-platform graphical process/system monitor with a customizable interface and a multitude of -features. Supports Linux, macOS, and Windows. +A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows. By default, bottom will look for a config file in ~/.config/bottom/bottom.toml. If one is not specified it will fall back to defaults. If a config file does not diff --git a/README.md b/README.md index 08572a23..0257796e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@

bottom (btm)

- A cross-platform graphical process/system monitor with a customizable interface and a multitude of features.
Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop. + A customizable cross-platform graphical process/system monitor for the terminal.
Supports Linux, macOS, and Windows. Inspired by gtop, gotop, and htop.

[CI status](https://github.com/ClementTsang/bottom/actions?query=branch%3Amaster) diff --git a/deployment/windows/choco/bottom.nuspec.template b/deployment/windows/choco/bottom.nuspec.template index 18db1f95..8fd18c77 100644 --- a/deployment/windows/choco/bottom.nuspec.template +++ b/deployment/windows/choco/bottom.nuspec.template @@ -33,9 +33,9 @@ This is a nuspec. It mostly adheres to https://docs.nuget.org/create/Nuspec-Refe https://github.com/ClementTsang/bottom/blob/master/README.md https://github.com/ClementTsang/bottom/issues cli cross-platform terminal top tui monitoring bottom btm - A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. + A customizable cross-platform graphical process/system monitor for the terminal. - A cross-platform graphical process/system monitor with a customizable interface and a multitude of features. Supports Linux, macOS, and Windows. Inspired by both [gtop](https://github.com/aksakalli/gtop) and [gotop](https://github.com/cjbassi/gotop). + A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows. Inspired by [gtop](https://github.com/aksakalli/gtop), [gotop](https://github.com/xxxserxxx/gotop) and [htop](https://github.com/htop-dev/htop). **Usage** To use, run `btm` in a terminal. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 62d2a42c..5a2c2ac0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -3,7 +3,7 @@ site_name: bottom site_author: Clement Tsang site_url: https://clementtsang.github.io/bottom site_description: >- - Yet another cross-platform graphical process/system monitor, inspired by gtop, gotop, and htop. + A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows. docs_dir: "content/" # Project information @@ -114,10 +114,6 @@ extra: version: provider: mike default: nightly - # GA - analytics: - provider: google - property: G-L04GTMT28R # Navigation nav: