Update setup instructions

This commit is contained in:
Matan Kushner
2019-03-17 14:57:03 -04:00
parent 0f2ee0ac31
commit 175ccf3141
2 changed files with 8 additions and 12 deletions

View File

@@ -1,7 +1,7 @@
<p align="center">
<img width="400" src="https://user-images.githubusercontent.com/4658208/54449507-a5595280-4724-11e9-95ce-ce0817dc7503.png">
<h3 align="center">bird-box</h3>
<p align="center">Update a pinned gist to contain the latest tweets of a user</p>
<img width="400" src="https://user-images.githubusercontent.com/4658208/54496333-6e21a780-48c4-11e9-8443-7e50a81a1bce.png">
<h3 align="center">waka-box</h3>
<p align="center">Update a pinned gist to contain your weekly WakaTime stats</p>
</p>
---
@@ -12,8 +12,8 @@
1. Create a new public GitHub Gist (https://gist.github.com/)
1. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new)
1. Create a new Twitter app (https://developer.twitter.com/en/apps/create)
1. On the App page for your newly created app, generate an "Access token & access token secret" and copy all keys and tokens.
1. Create a WakaTime account (https://wakatime.com/signup)
1. In your account settings, copy the existing WakaTime API Key (https://wakatime.com/settings/account)
### Project setup
@@ -26,8 +26,4 @@
- **GIST_ID:** The ID portion from your gist url `https://gist.github.com/matchai/`**`6d5f84419863089a167387da62dd7081`**.
- **GITHUB_TOKEN:** The GitHub token generated above.
- **TWITTER_USER:** The user handle of the twitter account.
- **TWITTER_CONSUMER_KEY:** Your Twitter consumer API key.
- **TWITTER_CONSUMER_SECRET:** Your Twitter consumer secret.
- **TWITTER_ACCESS_TOKEN_KEY:** Your Twitter access token key.
- **TWITTER_ACCESS_TOKEN_SECRET:** Your Twitter access token secret.
- **WAKATIME_API_KEY:** The API key for your WakaTime account.

View File

@@ -1,7 +1,7 @@
{
"name": "bird-box",
"name": "waka-box",
"version": "0.0.1",
"description": "🐦💬 Update a gist to contain your latest tweets",
"description": "📊 Update a gist to contain your weekly WakaTime stats",
"author": "Matan Kushner <hello@matchai.me>",
"license": "ISC",
"dependencies": {