taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Terribly rushed installation instructions into readme

Browse Source
This commit is contained in:
Chris Cummer 2018-04-09 14:19:07 -07:00 committed by Chris Cummer
parent 10142ebddc
commit 7958b76b45
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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