Add documentation for Blockfolio

wtfutil · Jun 13, 2018 · d812607 · d812607
1 parent d9e1624
commit d812607
Show file tree

Hide file tree

Showing 44 changed files with 360 additions and 8 deletions.
diff --git a/_site/content/posts/modules/cryptocurrencies/bittrex.md b/_site/content/posts/modules/cryptocurrencies/bittrex.md
@@ -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.
 

diff --git a/_site/content/posts/modules/cryptocurrencies/blockfolio.md b/_site/content/posts/modules/cryptocurrencies/blockfolio.md
@@ -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`.
diff --git a/_site/static/imgs/modules/blockfolio.png b/_site/static/imgs/modules/blockfolio.png
diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html
@@ -24,6 +24,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/404.html b/docs/404.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/categories/index.html b/docs/categories/index.html
@@ -67,6 +67,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/imgs/modules/blockfolio.png b/docs/imgs/modules/blockfolio.png
diff --git a/docs/index.html b/docs/index.html
@@ -66,6 +66,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/index.xml b/docs/index.xml
@@ -6,11 +6,28 @@
     <description>Recent content on WTF - A Terminal Dashboard</description>
     <generator>Hugo -- gohugo.io</generator>
     <language>en-us</language>
-    <lastBuildDate>Sun, 10 Jun 2018 19:41:52 -0400</lastBuildDate>
+    <lastBuildDate>Wed, 13 Jun 2018 09:29:59 -0700</lastBuildDate>
 
 	<atom:link href="https://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />
 
 
+    <item>
+      <title>Blockfolio</title>
+      <link>https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/</link>
+      <pubDate>Wed, 13 Jun 2018 09:29:59 -0700</pubDate>
+
+      <guid>https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/</guid>
+      <description>Added in v0.0.8.
+Display your Blockfolio crypto holdings.
+Source wtf/blockfolio/ Required ENV Variables None.
+Keyboard Commands None.
+Configuration blockfolio:colors:name:bluegrows:greendrop:reddevice_token:&amp;#34;device token&amp;#34;displayHoldings:trueenabled:trueposition:top:3left:1width:1height:1refreshInterval:400 Attributes colors.name Values: Any X11 color name.
+colors.grows Values: Any X11 color name.
+colors.drop Values: Any X11 color name.
+device_token Value: See this gist for details on how to get your Blockfolio API token.
+displayHoldings enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
+    </item>
+
     <item>
       <title>IP-API</title>
       <link>https://wtfutil.com/posts/modules/ipapi/</link>
@@ -94,7 +111,7 @@ Key: h Action: Show the previous project.</description>
       <guid>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</guid>
       <description>Added in v0.0.5.
 Get the last 24 hour summary of cryptocurrencies market using Bittrex.
-Source Code wtf/cryptoexchanges/bittrex/ Required ENV Vars None.
+Source Code wtf/cryptoexchanges/bittrex/ Required ENV Variables None.
 Keyboard Commands None.
 Configuration bittrex:enabled:trueposition:top:1left:2height:3width:1refreshInterval:5summary:BTC:displayName:Bitcoinmarket:-LTC-ETHcolors:base:name:orangedisplayName:redmarket:name:redfield:whitevalue:green Attributes colors.base.name Values: Any X11 color name.
 colors.base.dispayName Values: Any X11 color name.

diff --git a/docs/posts/configuration/attributes/index.html b/docs/posts/configuration/attributes/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/configuration/iterm2/index.html b/docs/posts/configuration/iterm2/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/index.html b/docs/posts/index.html
@@ -67,6 +67,7 @@ <h3 style="color: white;">Content</h3>
         <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>
@@ -104,6 +105,13 @@ <h3 style="color: white;">Content</h3>
             <h1 class="title">Posts</h1>
 <ul class="posts">
     <li>
+        <span>
+            <a href="https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/">Blockfolio</a>
+
+            <time class="pull-right post-list">Jun 13, 2018</time>    
+
+        </span>
+    </li><li>
         <span>
             <a href="https://wtfutil.com/posts/modules/ipapi/">IP-API</a>
 

diff --git a/docs/posts/index.xml b/docs/posts/index.xml
@@ -6,11 +6,28 @@
     <description>Recent content in Posts on WTF - A Terminal Dashboard</description>
     <generator>Hugo -- gohugo.io</generator>
     <language>en-us</language>
-    <lastBuildDate>Sun, 10 Jun 2018 19:41:52 -0400</lastBuildDate>
+    <lastBuildDate>Wed, 13 Jun 2018 09:29:59 -0700</lastBuildDate>
 
 	<atom:link href="https://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />
 
 
+    <item>
+      <title>Blockfolio</title>
+      <link>https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/</link>
+      <pubDate>Wed, 13 Jun 2018 09:29:59 -0700</pubDate>
+
+      <guid>https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/</guid>
+      <description>Added in v0.0.8.
+Display your Blockfolio crypto holdings.
+Source wtf/blockfolio/ Required ENV Variables None.
+Keyboard Commands None.
+Configuration blockfolio:colors:name:bluegrows:greendrop:reddevice_token:&amp;#34;device token&amp;#34;displayHoldings:trueenabled:trueposition:top:3left:1width:1height:1refreshInterval:400 Attributes colors.name Values: Any X11 color name.
+colors.grows Values: Any X11 color name.
+colors.drop Values: Any X11 color name.
+device_token Value: See this gist for details on how to get your Blockfolio API token.
+displayHoldings enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
+    </item>
+
     <item>
       <title>IP-API</title>
       <link>https://wtfutil.com/posts/modules/ipapi/</link>
@@ -94,7 +111,7 @@ Key: h Action: Show the previous project.</description>
       <guid>https://wtfutil.com/posts/modules/cryptocurrencies/bittrex/</guid>
       <description>Added in v0.0.5.
 Get the last 24 hour summary of cryptocurrencies market using Bittrex.
-Source Code wtf/cryptoexchanges/bittrex/ Required ENV Vars None.
+Source Code wtf/cryptoexchanges/bittrex/ Required ENV Variables None.
 Keyboard Commands None.
 Configuration bittrex:enabled:trueposition:top:1left:2height:3width:1refreshInterval:5summary:BTC:displayName:Bitcoinmarket:-LTC-ETHcolors:base:name:orangedisplayName:redmarket:name:redfield:whitevalue:green Attributes colors.base.name Values: Any X11 color name.
 colors.base.dispayName Values: Any X11 color name.

diff --git a/docs/posts/installation/index.html b/docs/posts/installation/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/modules/bamboohr/index.html b/docs/posts/modules/bamboohr/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/modules/circleci/index.html b/docs/posts/modules/circleci/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/modules/cmdrunner/index.html b/docs/posts/modules/cmdrunner/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>

diff --git a/docs/posts/modules/cryptocurrencies/bittrex/index.html b/docs/posts/modules/cryptocurrencies/bittrex/index.html
@@ -65,6 +65,7 @@ <h3 style="color: white;">Content</h3>
         <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>
@@ -126,7 +127,7 @@ <h1>Bittrex</h1>
 
 <h2 id="source-code">Source Code</h2>
 <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/cryptoexchanges/bittrex/</code></pre></div>
-<h2 id="required-env-vars">Required ENV Vars</h2>
+<h2 id="required-env-variables">Required ENV Variables</h2>
 
 <p>None.</p>