From cf33e2acec058ed11bc142fe16938d25dd45097b Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Sun, 3 Jun 2018 20:13:27 -0700 Subject: [PATCH] Add documentation for CryptoLive --- .../modules/cryptocurrencies/cryptolive.md | 88 ++++++++ _site/content/posts/modules/gcal.md | 2 +- .../hyde-hyde/layouts/partials/sidebar.html | 1 + docs/404.html | 1 + docs/categories/index.html | 1 + docs/index.html | 1 + docs/index.xml | 20 +- .../posts/configuration/attributes/index.html | 1 + docs/posts/configuration/index.html | 1 + docs/posts/configuration/iterm2/index.html | 1 + docs/posts/glossary/index.html | 1 + docs/posts/index.html | 8 + docs/posts/index.xml | 20 +- docs/posts/installation/index.html | 1 + docs/posts/modules/bamboohr/index.html | 1 + docs/posts/modules/clocks/index.html | 1 + docs/posts/modules/cmdrunner/index.html | 1 + .../cryptocurrencies/cryptolive/index.html | 201 ++++++++++++++++++ docs/posts/modules/gcal/index.html | 1 + docs/posts/modules/git/index.html | 1 + docs/posts/modules/github/index.html | 1 + docs/posts/modules/index.html | 1 + docs/posts/modules/ipinfo/index.html | 1 + docs/posts/modules/jira/index.html | 1 + docs/posts/modules/newrelic/index.html | 1 + docs/posts/modules/opsgenie/index.html | 1 + docs/posts/modules/power/index.html | 1 + docs/posts/modules/prettyweather/index.html | 1 + docs/posts/modules/security/index.html | 1 + docs/posts/modules/textfile/index.html | 1 + docs/posts/modules/todo/index.html | 1 + docs/posts/modules/weather/index.html | 1 + docs/posts/overview/index.html | 1 + docs/sitemap.xml | 9 +- docs/tags/index.html | 1 + 35 files changed, 371 insertions(+), 5 deletions(-) create mode 100644 _site/content/posts/modules/cryptocurrencies/cryptolive.md create mode 100644 docs/posts/modules/cryptocurrencies/cryptolive/index.html diff --git a/_site/content/posts/modules/cryptocurrencies/cryptolive.md b/_site/content/posts/modules/cryptocurrencies/cryptolive.md new file mode 100644 index 00000000..7d511c0b --- /dev/null +++ b/_site/content/posts/modules/cryptocurrencies/cryptolive.md @@ -0,0 +1,88 @@ +--- +title: "Cryptolive" +date: 2018-06-03T20:06:40-07:00 +draft: false +--- + +Added in `v0.0.5`. + +Compare crypto currencies using [CryptoCompare](https://cryptocompare.com). + +## Source Code + +```bash +wtf/cryptocurrencies/cryptolive/ +``` + +## Required ENV Vars + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +cryptolive: + colors: + from: + name: coral + displayName: grey + to: + name: white + price: green + currencies: + BTC: + displayName: Bitcoin + to: + - USD + - EUR + - ETH + ETH: + displayName: Ethereum + to: + - USD + - EUR + - ETH + enabled: true + position: + top: 5 + left: 2 + height: 1 + width: 2 + refreshInterval: 30 + updateInterval: 15 +``` + +### Attributes + +`colors.from.name`
+Values: Any X11 +color name. + +`colors.from.dispayName`
+Values: Any X11 +color name. + +`colors.to.name`
+Values: Any X11 +color name. + +`colors.to.price`
+Values: Any X11 +color name. + +`currencies`
+ +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/content/posts/modules/gcal.md b/_site/content/posts/modules/gcal.md index a5774fd3..3376f814 100644 --- a/_site/content/posts/modules/gcal.md +++ b/_site/content/posts/modules/gcal.md @@ -8,7 +8,7 @@ Displays your upcoming Google calendar events. gcal screenshot -**Not:** Setting up access to Google Calendars for Go is a bit unobvious. Check out Google's [Go Quickstart](https://developers.google.com/calendar/quickstart/go) +**Not:** Setting up access to Google Calendars for Go is a bit unobvious. Check out Google's [Go Quickstart](https://developers.google.com/calendar/quickstart/go) first and if you have problems, then take a look at this [comment by WesleydeSouza](https://github.com/senorprogrammer/wtf/issues/83#issuecomment-393665229) which offers a slightly different approach. ## Source Code diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index 8f91fd8e..dbf4b12b 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -24,6 +24,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/404.html b/docs/404.html index 4eed2f2b..1d0472f5 100644 --- a/docs/404.html +++ b/docs/404.html @@ -65,6 +65,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/categories/index.html b/docs/categories/index.html index 263164e0..5fe1e86c 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -67,6 +67,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/index.html b/docs/index.html index 99ae1e75..ec1f2290 100644 --- a/docs/index.html +++ b/docs/index.html @@ -66,6 +66,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/index.xml b/docs/index.xml index 2b3ff365..ff336a7b 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,29 @@ Recent content on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Sat, 02 Jun 2018 05:32:04 -0700 + Sun, 03 Jun 2018 20:06:40 -0700 + + Cryptolive + https://wtfutil.com/posts/modules/cryptocurrencies/cryptolive/ + Sun, 03 Jun 2018 20:06:40 -0700 + + https://wtfutil.com/posts/modules/cryptocurrencies/cryptolive/ + Added in v0.0.5. +Compare crypto currencies using CryptoCompare. +Source Code wtf/cryptocurrencies/cryptolive/ Required ENV Vars None. +Keyboard Commands None. +Configuration cryptolive:colors:from:name:coraldisplayName:greyto:name:whiteprice:greencurrencies:BTC:displayName:Bitcointo:-USD-EUR-ETHETH:displayName:Ethereumto:-USD-EUR-ETHenabled:trueposition:top:5left:2height:1width:2refreshInterval:30updateInterval:15 Attributes colors.from.name Values: Any X11 color name. +colors.from.dispayName Values: Any X11 color name. +colors.to.name Values: Any X11 color name. +colors.to.price Values: Any X11 color name. +currencies enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module’s widget will be displayed. + + Prettyweather https://wtfutil.com/posts/modules/prettyweather/ diff --git a/docs/posts/configuration/attributes/index.html b/docs/posts/configuration/attributes/index.html index 76a1a2cb..471b05aa 100644 --- a/docs/posts/configuration/attributes/index.html +++ b/docs/posts/configuration/attributes/index.html @@ -65,6 +65,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index ddf6f629..02125fe1 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -65,6 +65,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/posts/configuration/iterm2/index.html b/docs/posts/configuration/iterm2/index.html index 5c395343..7490a0a8 100644 --- a/docs/posts/configuration/iterm2/index.html +++ b/docs/posts/configuration/iterm2/index.html @@ -65,6 +65,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index d4533935..14cede16 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -65,6 +65,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • diff --git a/docs/posts/index.html b/docs/posts/index.html index 7409e432..c5612a65 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -67,6 +67,7 @@
  • Modules
  • BambooHR
  • Clocks
    • +
  • CryptoLive
  • CmdRunner
  • Git
  • Github
    • @@ -97,6 +98,13 @@

    Posts

    • + + Cryptolive + + + + +
    • Prettyweather diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 21b14d1e..89b03cfe 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -6,11 +6,29 @@ Recent content in Posts on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Sat, 02 Jun 2018 05:32:04 -0700 + Sun, 03 Jun 2018 20:06:40 -0700 + + Cryptolive + https://wtfutil.com/posts/modules/cryptocurrencies/cryptolive/ + Sun, 03 Jun 2018 20:06:40 -0700 + + https://wtfutil.com/posts/modules/cryptocurrencies/cryptolive/ + Added in v0.0.5. +Compare crypto currencies using CryptoCompare. +Source Code wtf/cryptocurrencies/cryptolive/ Required ENV Vars None. +Keyboard Commands None. +Configuration cryptolive:colors:from:name:coraldisplayName:greyto:name:whiteprice:greencurrencies:BTC:displayName:Bitcointo:-USD-EUR-ETHETH:displayName:Ethereumto:-USD-EUR-ETHenabled:trueposition:top:5left:2height:1width:2refreshInterval:30updateInterval:15 Attributes colors.from.name Values: Any X11 color name. +colors.from.dispayName Values: Any X11 color name. +colors.to.name Values: Any X11 color name. +colors.to.price Values: Any X11 color name. +currencies enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module’s widget will be displayed. + + Prettyweather https://wtfutil.com/posts/modules/prettyweather/ diff --git a/docs/posts/installation/index.html b/docs/posts/installation/index.html index 3b10455f..2e247ca7 100644 --- a/docs/posts/installation/index.html +++ b/docs/posts/installation/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/bamboohr/index.html b/docs/posts/modules/bamboohr/index.html index 410377b0..060a883a 100644 --- a/docs/posts/modules/bamboohr/index.html +++ b/docs/posts/modules/bamboohr/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index acb297d0..fdb2bc05 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/cmdrunner/index.html b/docs/posts/modules/cmdrunner/index.html index 22e9ddbf..51243f46 100644 --- a/docs/posts/modules/cmdrunner/index.html +++ b/docs/posts/modules/cmdrunner/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/cryptocurrencies/cryptolive/index.html b/docs/posts/modules/cryptocurrencies/cryptolive/index.html new file mode 100644 index 00000000..cd17c393 --- /dev/null +++ b/docs/posts/modules/cryptocurrencies/cryptolive/index.html @@ -0,0 +1,201 @@ + + + + + + + + + + + + +Cryptolive | WTF - A Terminal Dashboard + + + + + + + + + + + + + + + + + + + + + + + + + +
      +
      +
      + + WFT Logo +

      + +

      +
      + + + +

      + © 2018 Chris Cummer. +
      + Some Rights Reserved. + +

      +
      +
      + +
      +
      +

      Cryptolive

      + +
      + + + + Jun 03, 2018 + + + + +
      + +       +
      + + + +

      Added in v0.0.5.

      + +

      Compare crypto currencies using CryptoCompare.

      + +

      Source Code

      +
      wtf/cryptocurrencies/cryptolive/
      +

      Required ENV Vars

      + +

      None.

      + +

      Keyboard Commands

      + +

      None.

      + +

      Configuration

      +
      cryptolive:
+  colors:
+    from:
+      name: coral
+      displayName: grey
+    to:
+      name: white
+      price: green
+  currencies:
+    BTC:
+      displayName: Bitcoin
+      to:
+        - USD
+        - EUR
+        - ETH
+    ETH:
+      displayName: Ethereum
+      to:
+        - USD
+        - EUR
+        - ETH
+  enabled: true
+  position:
+    top: 5
+    left: 2
+    height: 1
+    width: 2
+  refreshInterval: 30
+  updateInterval: 15
      +

      Attributes

      + +

      colors.from.name
      +Values: Any X11 +color name.

      + +

      colors.from.dispayName
      +Values: Any X11 +color name.

      + +

      colors.to.name
      +Values: Any X11 +color name.

      + +

      colors.to.price
      +Values: Any X11 +color name.

      + +

      currencies

      + +

      enabled
      +Determines whether or not this module is executed and if its data displayed onscreen.
      +Values: true, false.

      + +

      position
      +Defines where in the grid this module’s widget will be displayed.

      + +

      refreshInterval
      +How often, in seconds, this module will update its data.
      +Values: A positive integer, 0..n.

      + +
      + +
      + + + +
      +
      + + + + diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index 6991cc95..06d9687a 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/git/index.html b/docs/posts/modules/git/index.html index 5036a5b5..54fbf39d 100644 --- a/docs/posts/modules/git/index.html +++ b/docs/posts/modules/git/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/github/index.html b/docs/posts/modules/github/index.html index 92ccd756..a6af2afb 100644 --- a/docs/posts/modules/github/index.html +++ b/docs/posts/modules/github/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index f6fe6128..0f23575f 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/ipinfo/index.html b/docs/posts/modules/ipinfo/index.html index 82387b46..d8263157 100644 --- a/docs/posts/modules/ipinfo/index.html +++ b/docs/posts/modules/ipinfo/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index de2bb5b5..49a069e2 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/newrelic/index.html b/docs/posts/modules/newrelic/index.html index 95ce89aa..33523eb5 100644 --- a/docs/posts/modules/newrelic/index.html +++ b/docs/posts/modules/newrelic/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index dbecdaba..af21cf3b 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/power/index.html b/docs/posts/modules/power/index.html index d0acf8d0..0a9f05ad 100644 --- a/docs/posts/modules/power/index.html +++ b/docs/posts/modules/power/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/prettyweather/index.html b/docs/posts/modules/prettyweather/index.html index 2502de3e..84169e4d 100644 --- a/docs/posts/modules/prettyweather/index.html +++ b/docs/posts/modules/prettyweather/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/security/index.html b/docs/posts/modules/security/index.html index 371e5197..eaa66c7c 100644 --- a/docs/posts/modules/security/index.html +++ b/docs/posts/modules/security/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/textfile/index.html b/docs/posts/modules/textfile/index.html index e1a0bc26..19d5f84b 100644 --- a/docs/posts/modules/textfile/index.html +++ b/docs/posts/modules/textfile/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html index 45c15d11..ae296a70 100644 --- a/docs/posts/modules/todo/index.html +++ b/docs/posts/modules/todo/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/modules/weather/index.html b/docs/posts/modules/weather/index.html index 953f1f37..eeeefa97 100644 --- a/docs/posts/modules/weather/index.html +++ b/docs/posts/modules/weather/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/posts/overview/index.html b/docs/posts/overview/index.html index 3b8c7f0d..d66ec009 100644 --- a/docs/posts/overview/index.html +++ b/docs/posts/overview/index.html @@ -65,6 +65,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github
      • diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 486fc7eb..38034fc0 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + https://wtfutil.com/posts/modules/cryptocurrencies/cryptolive/ + 2018-06-03T20:06:40-07:00 + + https://wtfutil.com/posts/modules/prettyweather/ 2018-06-02T05:32:04-07:00 @@ -124,7 +129,7 @@ https://wtfutil.com/posts/ - 2018-06-02T05:32:04-07:00 + 2018-06-03T20:06:40-07:00 0 @@ -135,7 +140,7 @@ https://wtfutil.com/ - 2018-06-02T05:32:04-07:00 + 2018-06-03T20:06:40-07:00 0 diff --git a/docs/tags/index.html b/docs/tags/index.html index 3d782109..5124d493 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -67,6 +67,7 @@
    • Modules
    • BambooHR
    • Clocks
      • +
    • CryptoLive
    • CmdRunner
    • Git
    • Github