Commit 1bc1316b authored by Deac Karns's avatar Deac Karns
Browse files

initial commit

parents
node_modules/
# EthReal
A command line utility that will display the current market values of the Cryptocurrencies you care most about right in your terminal. EthReal utilizes data from the [coinmarketcap.com](https://coinmarketcap.com) top 100.
- [Install](#install)
- [Useage](#useage)
- [Configuration](#configuration)
- [Following a Cryptocurrency](#following-a-cryptocurrency)
- [Colors](#colors)
- [Options](#options)
- [Supported Cryptocurrencies](#supported-cryptocurrencies)
### Install
```
npm install ethreal -g
```
### Useage
```
ethreal
```
### Output
```
╔══════════════╤══════════╤════════╤════════╤═══════════╤══════════╗
║ Crypto │ USD │ 24h │ 7d │ Holding │ USD ║
╟──────────────┼──────────┼────────┼────────┼───────────┼──────────╢
║ Bitcoin │ $15477.3 │ 8.5 │ -19.49 │ - │ - ║
╟──────────────┼──────────┼────────┼────────┼───────────┼──────────╢
║ Ethereum │ $759.211 │ 9.31 │ 9.0 │ 2 │ $1518.42 ║
╟──────────────┼──────────┼────────┼────────┼───────────┼──────────╢
║ Bitcoin Cash │ $3448.4 │ 19.08 │ 90.88 │ 1 │ $3448.40 ║
╟──────────────┼──────────┼────────┼────────┼───────────┼──────────╢
║ Litecoin │ $304.587 │ 9.87 │ 0.93 │ 0.1194417 │ $36.38 ║
╚══════════════╧══════════╧════════╧════════╧═══════════╧══════════╝
```
### Configuration
All the configuration data is stored in a `json` file in your home directory `~/.ethreal`
### Holdings
You can now calculate the value of your holdings automatically with EthReal. Holdings data is stored in the configuration file `~/.ethreal` as a type float. No private data is saved or stored, just a number.
##### Add Holdings
Example adding `0.001234` to your bitcoin holdings
```
ethreal -a 0.001234 -s btc
```
##### Remove Holdings
Example removing `0.001234` from your bitcoin holdings
```
ethreal -r 0.001234 -s btc
```
### Following a Cryptocurrency
###### Follow
Example, start following Bytecoin. the color option is optional. `red` will be used by default
```
ethreal -f bcn -c yellow
```
###### Un-follow
Example, stop following Bytecoin
```
ethreal -u bcn
```
### Colors
Changing the color of a cryptocurrency row is easy.
```
ethreal -s btc -c blue
```
##### Available colors
black, red, green, yellow, blue, magenta, cyan, white, gray, grey,
bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite,
reset, bold, dim, italic, underline, inverse, hidden, strikethrough,
rainbow, zebra, america, trap, random
### Additional Options
```
ethreal -h
```
### Supported Cryptocurrencies
EthReal is currently able to display the current market value in USD for the [coinmarketcap.com](https://coinmarketcap.com) top 100:
This diff is collapsed.
{
"name": "spotihandy",
"version": "0.0.0",
"description": "a node CLI app for working with the spotify API",
"main": "spotihandy",
"bin": {
"spotihandy": "./spotihandy"
},
"dependencies": {
"cli-table": "^0.3.1",
"commander": "^2.12.2",
"fs": "0.0.1-security",
"graceful-fs": "^4.1.11",
"inquirer": "^6.2.2",
"request": "^2.88.0",
"request-promise": "^4.2.4",
"spotify-web-api-js": "^1.2.0",
"spotify-web-api-node": "^4.0.0",
"spotify-web-sdk": "^0.5.0"
},
"devDependencies": {},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [
"bitcoin",
"etherum"
],
"author": "Deac Karns",
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/peledies/spotihandy.git"
},
"homepage": "https://github.com/peledies/spotihandy.git"
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment