summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiguel Mota <hello@miguelmota.com>2021-11-16 08:52:30 -0800
committerMiguel Mota <hello@miguelmota.com>2021-11-16 08:52:30 -0800
commit0cfb00c2b4b3a6b9dc0629497123dc51d9875809 (patch)
tree4764854ef766fec2b88618e18b8327dc9fbacb67
parent4250a056303458819eb83fe678883dfe58af8a3c (diff)
parent2e0a797efb6020cf68561bdca15adcff4ae91bc7 (diff)
Merge branch 'feature/doc-updates' of https://github.com/lyricnz/cointop into lyricnz-feature/doc-updates
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index aaf98d3..5d22906 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,8 @@ The interface is inspired by [`htop`](https://en.wikipedia.org/wiki/Htop) and sh
## Demo
+This connects to an instance of Cointop using SSH:
+
```bash
ssh cointop.sh
```
@@ -56,21 +58,20 @@ Documentation has been moved to [docs.cointop.sh](https://docs.cointop.sh/)
## Features
- Quick sort shortcuts
-- Custom key bindings configuration
-- Vim inspired shortcut keys
+- Vim inspired shortcut keys, Custom key bindings configuration
+- Mouse support
- Fast pagination
- Charts for coins and global market graphs
- Quick chart date range change
- Fuzzy searching for finding coins
- Currency conversion
- Save and view favorite coins
-- Portfolio tracking of holdings
-- 256-color support
-- Custom colorschemes
+- Portfolio tracking of holdings, PNL
+- Price Alerts with Desktop Notifications
+- Custom colorschemes, 256-color and 24-bit support
- Help menu
-- Offline cache
+- Auto-refresh, Offline cache
- Supports multiple coin stat APIs
-- Auto-refresh
- Works on macOS, Linux, and Windows
- It's very lightweight; can be left running indefinitely