From 7958b76b459fd15f1609ae98b543ce0a55aad457 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Mon, 9 Apr 2018 14:19:07 -0700 Subject: [PATCH] Terribly rushed installation instructions into readme --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 2c13b487..3c8977f9 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,18 @@ WTF is a personal terminal-based dashboard utility, designed for displaying infrequently-updating, but very important, daily data. +## Installation + +1. Clone this directory and install all the dependencies. +2. Create a directory called `.wtf` in your `home` directory (ie: + `~/.wtf/`) +3. In that directory copy the `config.yml` file (ie: `~/.wtf/config.yml`) +4. Disable all the modules for which you need an API key, by setting + `enabled: false` in the config file +5. `go run wtf.go` + +It'll probably run. + ## Modules Modules are the heart of WTF. Each one connects to a specific services