Commit af81ac36 authored by Deac Karns's avatar Deac Karns
Browse files

production ready

parent 17cfefc5
# 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.
# Spotiko
A command line utility for adding your current playing song to a pre-existing playlist. This is primarily a
convenience program so you dont have to keep leaving your development environment to save songs you like.
- [Install](#install)
- [Useage](#useage)
- [Configuration](#configuration)
- [Following a Cryptocurrency](#following-a-cryptocurrency)
- [Colors](#colors)
- [Options](#options)
- [Supported Cryptocurrencies](#supported-cryptocurrencies)
- [Useage](#useage)
### 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 ║
╚══════════════╧══════════╧════════╧════════╧═══════════╧══════════╝
npm install spotiko -g
```
### Configuration
All the configuration data is stored in a `json` file in your home directory `~/.ethreal`
All the configuration data is stored in a `json` file in your home directory `~/.spotiko`
### 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.
The first time you run spotiko it will prompt you for the following details. obtaining them
can be found at the spotify documentation for developers https://developer.spotify.com/dashboard/
- client id
- client secret
##### 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
### Useage
Add current track to a playlist
```
ethreal -r 0.001234 -s btc
spotiko -a
```
### Following a Cryptocurrency
###### Follow
Example, start following Bytecoin. the color option is optional. `red` will be used by default
View the current configuration
```
ethreal -f bcn -c yellow
spotiko -s
```
###### Un-follow
Example, stop following Bytecoin
View details about the current track
```
ethreal -u bcn
spotiko -c
```
### Colors
Changing the color of a cryptocurrency row is easy.
View the tracks in a playlist
```
ethreal -s btc -c blue
spotiko -p
```
##### 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
spotiko -h
```
### Supported Cryptocurrencies
EthReal is currently able to display the current market value in USD for the [coinmarketcap.com](https://coinmarketcap.com) top 100:
{
"name": "spotiko",
"version": "0.0.4",
"version": "0.1.0",
"description": "a node CLI app for working with the spotify API",
"main": "spotiko",
"bin": {
......
......@@ -19,7 +19,7 @@ table = new Table({
});
program
.version('0.0.4')
.version('0.1.0')
.option('-a, --add', 'Add current track to default playlist', 0)
.option('-s, --settings', 'Display the current configuration', 0)
.option('-c, --current', 'Display the current playing track', 0)
......
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