2
0
mirror of https://github.com/miguelmota/cointop synced 2024-11-14 18:12:57 +00:00
cointop/README.md

139 lines
4.4 KiB
Markdown
Raw Normal View History

2019-01-19 23:25:06 +00:00
<h3 align="center">
2018-05-02 06:53:15 +00:00
<br />
2019-01-19 23:25:06 +00:00
<img src="https://user-images.githubusercontent.com/168240/39561871-51cda852-4e5d-11e8-926b-7692d43143e8.png" alt="logo" width="400" />
2018-05-02 06:53:15 +00:00
<br />
<br />
<br />
2019-01-19 23:25:06 +00:00
</h3>
# cointop
2018-03-29 22:02:24 +00:00
> Coin tracking for hackers
2019-06-29 19:57:56 +00:00
[![License](http://img.shields.io/badge/license-Apache-blue.svg)](https://raw.githubusercontent.com/miguelmota/cointop/master/LICENSE)
2019-04-17 04:48:38 +00:00
[![Build Status](https://travis-ci.org/miguelmota/cointop.svg?branch=master)](https://travis-ci.org/miguelmota/cointop)
[![Go Report Card](https://goreportcard.com/badge/github.com/miguelmota/cointop?)](https://goreportcard.com/report/github.com/miguelmota/cointop)
[![GoDoc](https://godoc.org/github.com/miguelmota/cointop?status.svg)](https://godoc.org/github.com/miguelmota/cointop)
[![Mentioned in Awesome Terminals](https://awesome.re/mentioned-badge.svg)](https://github.com/k4m4/terminals-are-sexy)
2019-12-19 01:14:02 +00:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#contributing)
2018-04-26 17:16:34 +00:00
[`cointop`](https://github.com/miguelmota/cointop) is a fast and lightweight interactive terminal based UI application for tracking and monitoring cryptocurrency coin stats in real-time.
2018-04-26 17:17:11 +00:00
The interface is inspired by [`htop`](https://en.wikipedia.org/wiki/Htop) and shortcut keys are inspired by [`vim`](https://en.wikipedia.org/wiki/Vim_(text_editor)).
2018-04-26 17:13:04 +00:00
2018-05-03 18:55:30 +00:00
<img src="https://user-images.githubusercontent.com/168240/39569578-7ce9f3b6-4e7a-11e8-82a9-8a18b91b1bd5.png" alt="cointop screenshot" width="880" />
2018-04-26 17:15:23 +00:00
## Demo
```bash
ssh cointop.sh
```
2018-04-28 20:23:55 +00:00
In action
2018-04-26 17:15:23 +00:00
2018-05-03 18:55:30 +00:00
<img src="https://user-images.githubusercontent.com/168240/39569570-75b1547c-4e7a-11e8-8eac-552abaa431f0.gif" alt="screencast" width="880" />
2018-04-26 17:14:03 +00:00
## Table of Contents
- [Features](#features)
2021-02-21 05:21:48 +00:00
- [Documentation](#documentation)
- [Install](#install)
- [Update](#update)
2018-12-24 09:10:36 +00:00
- [Getting started](#getting-started)
- [Shortcuts](#shortcuts)
2019-06-09 21:53:30 +00:00
- [Colorschemes](#colorschemes)
- [Config](#config)
2020-07-26 20:40:59 +00:00
- [SSH server](#ssh-server)
- [FAQ](#faq)
2019-12-19 01:14:02 +00:00
- [Contributing](#contributing)
2020-12-19 14:05:31 +00:00
- [Social](#social)
2021-02-21 05:11:27 +00:00
- [Mentioned in](#mentioned-in)
- [Tip Jar](#tip-jar)
- [License](#license)
## Features
- Quick sort shortcuts
2019-05-15 17:47:02 +00:00
- Custom key bindings configuration
- Vim inspired shortcut keys
- Fast pagination
- Charts for coins and global market graphs
2018-05-02 22:51:34 +00:00
- Quick chart date range change
- Fuzzy searching for finding coins
2018-05-07 07:51:29 +00:00
- Currency conversion
- Save and view favorite coins
2018-12-24 09:10:36 +00:00
- Portfolio tracking of holdings
2019-05-15 17:47:02 +00:00
- 256-color support
2019-06-09 21:28:26 +00:00
- Custom colorschemes
- Help menu
2018-04-26 22:53:15 +00:00
- Offline cache
2019-05-15 17:47:02 +00:00
- Supports multiple coin stat APIs
- Auto-refresh
- Works on macOS, Linux, and Windows
2018-12-24 09:10:36 +00:00
- It's very lightweight; can be left running indefinitely
2021-02-21 05:21:48 +00:00
## Documentation
2018-03-29 22:04:28 +00:00
2021-02-21 05:21:48 +00:00
Documentation has been moved to [docs.cointop.sh](https://docs.cointop.sh/)
2018-05-21 07:42:32 +00:00
2021-02-21 05:21:48 +00:00
Some helpful documentation links are provided below.
2021-02-21 05:21:48 +00:00
## Install
2020-12-20 02:48:01 +00:00
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/install](https://docs.cointop.sh/install)
2021-02-21 05:21:48 +00:00
## Update
See [docs.cointop.sh/update](https://docs.cointop.sh/update)
2018-12-26 23:34:39 +00:00
## Shortcuts
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/shortcuts](https://docs.cointop.sh/shortcuts)
2019-06-09 21:53:30 +00:00
## Colorschemes
2019-06-09 21:28:26 +00:00
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/colorschemes](https://docs.cointop.sh/colorschemes)
2019-06-09 21:28:26 +00:00
## Config
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/config](https://docs.cointop.sh/config)
2020-07-26 20:40:59 +00:00
## SSH Server
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/ssh](https://docs.cointop.sh/ssh)
2020-08-03 02:52:24 +00:00
## FAQ
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/faq](https://docs.cointop.sh/faq)
2019-05-13 02:24:10 +00:00
2021-02-21 05:11:27 +00:00
## Contributing
2020-07-26 20:40:59 +00:00
2021-02-21 05:21:48 +00:00
See [docs.cointop.sh/contributing](https://docs.cointop.sh/contributing)
2021-09-26 07:36:26 +00:00
_Many thanks to [Simon Roberts](https://github.com/lyricnz), [Alexis Hildebrandt](https://github.com/afh), and all the [contributors](https://github.com/miguelmota/cointop/graphs/contributors) that made cointop better._
2021-02-21 05:21:48 +00:00
## Social
2021-02-21 05:11:27 +00:00
- Follow on twitter [@cointop](https://twitter.com/cointop)
- Discuss on [Discord](https://discord.gg/pUVGy7ECGg)
2019-02-27 00:34:22 +00:00
## Mentioned in
Cointop has been mentioned in:
2021-02-21 05:21:48 +00:00
- [@Ubuntu Twitter](https://twitter.com/ubuntu/status/985947962311311360?lang=en)
2019-02-27 00:34:22 +00:00
- [Terminals Are Sexy](https://github.com/k4m4/terminals-are-sexy#tools-and-plugins)
2019-07-09 00:25:30 +00:00
- [The Changelog News](https://changelog.com/news/cointop-coin-tracking-for-hackers-rAzZ)
2019-02-27 00:34:22 +00:00
2019-06-02 05:04:42 +00:00
### Tip Jar
[![BTC Tip Jar](https://img.shields.io/badge/BTC-tip-yellow.svg?logo=bitcoin&style=flat)](https://www.blockchain.com/btc/address/3KdMW53vUMLPEC33xhHAUx4EFtvmXQF8Kf) `3KdMW53vUMLPEC33xhHAUx4EFtvmXQF8Kf`
[![ETH Tip Jar](https://img.shields.io/badge/ETH-tip-blue.svg?logo=ethereum&style=flat)](https://etherscan.io/address/0x0072cdd7c3d9963ba69506ECf50e16E963B35bb1) `0x0072cdd7c3d9963ba69506ECf50e16E963B35bb1`
Thank you for tips! 🙏
2018-03-29 22:02:24 +00:00
## License
2019-06-09 21:28:26 +00:00
Released under the [Apache 2.0](./LICENSE) license.