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

Make readme better

Browse source
This commit is contained in:
RGBCube 2023-01-15 20:12:54 +03:00 • committed by GitHub
parent 3cbe645c46
commit 8f3a10ee2d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

62
readme.md
View file

@ -1,45 +1,41 @@
# Twitter -> Discord Webhook
Simple (enough) to configure into a discord webhook. Runs on Node.js
Simple (enough) to configure Twitter -> Discord webhook. Runs on Node.js
## Setup
(Provided you already have node.js installed otherwise install it [here](https://nodejs.org/en/))
Clone this project then configure in *config/config.json* then run to install all dependencies
### Clone This Project & Cd Into It
> You will need `git` installed to do this!
```sh
git clone https://github.com/Stovven/discord-twitter-webhook
cd discord-twitter-webhook
```
### Configure
Edit the `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.
### 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/).
```sh
npm install
```
Finally run this command to run the tool
```
### Run
```sh
node main.js
```
## Config
```json
{
"webhook_url": "",
"webhook_name": "",
"webhook_avatar": "",
"webhook_message": "",
"api_key": "",
"api_secret": "",
"access_token": "",
"acesss_secret": "",
"user_id": ""
}
```
* **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 name of your webhook
* **Webhook_avatar**: The avatar of your webhook
* **Webhook_message**: The message before your Twitter link
* **api_key**: Twitter API key, if you do not have a Twitter developer account then check out [this](https://developer.twitter.com/en) page
* **api_secret**: Twitter API secret, requires Twitter developer account
* **access_token**: Twitter account access token, requires Twitter developer account
* **access_secret**: Twitter account acesss secret, requires 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
---
*this took too long for what it is lol*