RGBCube/TwitterDiscordWebhook
1
Fork 0
mirror of https://github.com/RGBCube/TwitterDiscordWebhook synced 2025-07-28 05:27:44 +00:00
Code Issues Activity Actions

chore & readme: better config

Browse source
This commit is contained in:
RGBCube 2023-01-17 06:01:25 -05:00
parent 5047b38f4e
commit fd73c2ad1f
3 changed files with 42 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -14,15 +14,15 @@ cd discord-twitter-webhook
### Configure
Edit the `config.example.json` and rename it to `config.json` with the given information below:
* `webhook_url`: The Discord webhook url, for more information check out [this](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) page.
* `webhook_name`: The username of your Discord webhook.
* `webhook_avatar`: The avatar of your Discord webhook.
* `webhook_message`: The message before your Twitter link. Formatted as `{message} {tweet_link}`, no newline added.
* `api_key`: The Twitter API key, if you do not have a Twitter developer account then check out [this](https://developer.twitter.com/en) page.
* `api_secret`: The Twitter API secret, requires a Twitter developer account.
* `access_token`: The Twitter account access token, requires a Twitter developer account.
* `access_secret`: The Twitter account acesss secret, requires a Twitter developer account.
* `user_id`: The user ID for the Twitter account you want notifications from, to find a Twitter id use [this](https://tweeterid.com/) tool.
* `discord.webhookUrl`: The Discord webhook url, for more information check out [this](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) page.
* `discord.webhookName`: The username of your Discord webhook.
* `discord.webhookAvatar`: The avatar of your Discord webhook.
* `discord.webhookMessage`: The message before your Twitter link. Formatted as `{message} {tweet_link}`, no newline added.
* `twitter.apiKey`: The Twitter API key, if you do not have a Twitter developer account then check out [this](https://developer.twitter.com/en) page.
* `twitter.apiSecret`: The Twitter API secret, requires a Twitter developer account.
* `twitter.accessToken`: The Twitter account access token, requires a Twitter developer account.
* `twitter.accessSecret`: The Twitter account acesss secret, requires a Twitter developer account.
* `followingUserId`: The user ID for the Twitter account you want notifications from, to find a Twitter id use [this](https://tweeterid.com/) tool.
### Install Dependencies
> You will need Node.js installed to do this and the next section! If you don't have it installed, you can install it from [here](https://nodejs.org/en/).