1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Add documentation for Blockfolio

This commit is contained in:
Chris Cummer
2018-06-13 09:41:48 -07:00
parent d9e1624304
commit d812607479
44 changed files with 360 additions and 8 deletions

View File

@@ -16,7 +16,7 @@ Get the last 24 hour summary of cryptocurrencies market using [Bittrex](https://
wtf/cryptoexchanges/bittrex/
```
## Required ENV Vars
## Required ENV Variables
None.

View File

@@ -0,0 +1,75 @@
---
title: "Blockfolio"
date: 2018-06-13T09:29:59-07:00
draft: false
---
Added in `v0.0.8`.
Display your Blockfolio crypto holdings.
<img src="/imgs/modules/blockfolio.png" width="320" height="185" alt="blockfolio screenshot" />
## Source
```bash
wtf/blockfolio/
```
## Required ENV Variables
None.
## Keyboard Commands
None.
## Configuration
```yaml
blockfolio:
colors:
name: blue
grows: green
drop: red
device_token: "device token"
displayHoldings: true
enabled: true
position:
top: 3
left: 1
width: 1
height: 1
refreshInterval: 400
```
### Attributes
`colors.name` <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.grows` <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.drop` <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`device_token` <br />
Value: See [this gist](https://github.com/bob6664569/blockfolio-api-client) for
details on how to get your Blockfolio API token.
`displayHoldings` <br />
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0..n`.

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

View File

@@ -24,6 +24,7 @@
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/bittrex/">Bittrex</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/blockfolio/">Blockfolio</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/circleci/">CircleCI</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/cryptolive/">CryptoLive</a></li>