1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Update the Twitter documentation

This commit is contained in:
Chris Cummer
2018-08-01 14:32:04 -07:00
parent 049061bbf4
commit dfc34380ef
8 changed files with 258 additions and 14 deletions

View File

@@ -52,6 +52,7 @@ gcal:
width: 1
refreshInterval: 300
secretFile: "~/.config/wtf/gcal/client_secret.json"
showDeclined: true
withLocation: true
```
@@ -123,5 +124,9 @@ Your <a href="https://developers.google.com/calendar/quickstart/go">Google clien
Values: A string representing a file path to the JSON secret file.
`showDeclined` <br />
Whether or not to display events you've declined to attend. <br />
_Optional_. Whether or not to display events you've declined to attend. <br />
Values: `true`, or `false`
`withLocation` <br />
Whether or not to show the location of the appointment. <br />
Values: `true`, or `false`

View File

@@ -4,18 +4,17 @@ date: 2018-07-31T20:21:37-07:00
draft: false
---
Connects to the Twitter API and displays a single user's tweets
NOTE: This only works for single-application developer accounts for now
Added in `v0.1.2`.
Connects to the Twitter API and displays a single user's tweets.
NOTE: This only works for single-application developer accounts for now.
## Source Code
```bash
wtf/twitter/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_TWITTER_BEARER_TOKEN` <br />
<span class="caption">Action:</span> Your <a href="https://developer.twitter.com/en/docs/basics/authentication/overview/application-only.html">Twitter single-application Bearer Token</a><br />
## Keyboard Commands
@@ -25,6 +24,7 @@ None.
```yaml
twitter:
bearerToken: "3276d7155dd9ee27b8b14f8743a408a9"
enabled: true
position:
top: 0
@@ -36,6 +36,9 @@ twitter:
### Attributes
`bearerToken` <br />
Value: Your <a href="https://developer.twitter.com/en/docs/basics/authentication/overview/application-only.html">Twitter single-application Bearer Token</a>
`enabled` <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.