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

Improved the readme

Browse Source
This commit is contained in:
Chris Cummer 2018-04-10 09:20:59 -07:00 committed by Chris Cummer
parent 5637adf601
commit 948d5acb2a
1 changed files with 50 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -44,39 +44,68 @@ It'll probably run.
## Modules ## Modules
Modules are the heart of WTF. Each one connects to a specific services Modules are the heart of `WTF`. Each one connects to a specific services
or renders data about a specific concept. The following modules are or renders data about a specific concept. The following modules are
included in WTF. included in `WTF`.
### BambooHR #### BambooHR
Displays who's out on vacation or off sick today. Displays the following Away information for your organization:
### Git * Names of the people away today
* Datespan for when they'll be away
Displays the current branch, a list of changed files, and the last n #### Git
commits for a specified repository.
### Github Specify a local git repository to watch for the following:
Displays your open pull requests and any code review requests assigned * Current branch name
to you. * List all changed files
* List last n commits against that branch
### Google Calendar #### Github
Displays the next n calendar events. Specify a Github repository to watch for the following:
### OpsGenie * Lists all open code review requests assigned to you
* Lists all open pull requests created by you
Displays who's currently on call for all your schedules. #### Google Calendar
### Security Displays the following information about your upcoming calendar events:
Displays whether or not your firewall is on and configured in 'stealth' * Event title
mode. Also displays the name of the current Wifi network and whether * Date and time
or not it's encrypted. * Hours/minutes/seconds until event
### Weather #### OpsGenie
Displays the temperatures for the day, weather description, and the Displays the following on-call information for all your active schedules:
sunrise and sunset times.
* Schedule name
* Who's currently on call
#### Security
Displays the following security/network related information about your
local machine:
* Wifi network name
* Wifi network encryption
* Firewall enabled/disabled
* Firewall stealth mode enabled/disabled
* DNS entries
#### Weather
Displays the following current weather information for the specified city:
* weather description
* current temperature
* today's high
* today's low
* sunrise
* sunset
In the configuration, use a city code from the OpenWeatherMap [city
list](http://openweathermap.org/help/city_list.txt).