shaunstanislauslau / wtf Goto Github PK

A personal terminal-based dashboard utility, designed for displaying infrequently-needed, but very important, daily data.

Quick Start

Installation from Source

Note: Requires go v1.7 or later (because it uses the context package).

go get github.com/senorprogrammer/wtf
cd $GOPATH/src/github.com/senorprogrammer/wtf
make install
make run

See https://wtfutil.com for the definitive documentation. Here's some short-cuts:

• Installation
• Configuration
• Module Documentation

And a "probably up-to-date" list of currently-implemented modules:

• BambooHR
• World Clocks
• Command Runner
• Google Calendar
• Git
• GitHub
• Jira
• New Relic
• OpsGenie
• Power
• Security
• Textfile
• Todo List
• Weather

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Authors

• Chris Cummer, senorprogrammer

License

See LICENSE.md file for details.

Acknowledgments

The inspiration for WTF came from Monica Dinculescu's tiny-care-terminal.

Many thanks to Lendesk for supporting this project by providing time to develop it.

The following open-source libraries were used in the creation of WTF. Many thanks to all these developers.

• calendar
• config
• go-github
• goreleaser
• newrelic
• openweathermap
• tcell
• tview