Skip to content

Commit

Permalink
update project name
Browse files Browse the repository at this point in the history
twitfix -> linkfix
  • Loading branch information
RalphORama committed Oct 12, 2023
1 parent 55dcfdc commit 4c8877a
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 9 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FROM node:lts-alpine

LABEL org.opencontainers.image.title="twitfix for Discord" \
org.opencontainers.image.description="A Discord bot that replies to messages containing x.com/twitter.com lins with fxtwitter.com links for better embed support." \
LABEL org.opencontainers.image.title="LinkFix for Discord" \
org.opencontainers.image.description="LinkFix is a Discord bot that replies to messages containing annoying links (Twitter, YouTube Shorts) with better ones (fxtwitter, youtu.be)" \
org.opencontainers.image.authors="Lily Skye <me@suchipi.com>, Ralph <ralph@podaboutli.st>" \
org.opencontainers.image.licenses="AGPL-3.0-or-later"

Expand Down
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,33 @@
# twitfix for Discord
# LinkFix for Discord

A simple Discord bot that replies to messages containing `x.com`/`twitter.com` links with an equivalent `fxtwitter.com` link for better embed support.
LinkFix for Discord replies to messages containing URLS that don't embed
properly (`x.com`, `twitter.com`, YouTube Shorts) with URLS that do
(`fxtwitter.com`, `youtu.be`).


## [Click Here][1] to add twitfix to your server!
## [Click Here][1] to add LinkFix to your Discord server!


## Development
## Self-Hosting

You can easily self-host this bot with Docker using the following steps:

1. Copy `docker-compose.example.yml` to `docker-compose.yml`
2. Edit `docker-compose.yml` and change the line reading `DISCORD_BOT_TOKEN=` to specify your bot's token
3. Run `docker compose up -d` to start the bot

See [discordjs.guide][2] for instructions on how to install Node.js, set up a bot, get a token, and add it to a server
**NB:** See [discordjs.guide][2] for instructions on how to install Node.js,
set up a bot, get a token, and add it to a server.


## Contributing

tbd.


## License

See LICENSE.txt
See `LICENSE.txt`


[1]: https://discord.com/oauth2/authorize?client_id=385950397493280805&scope=bot&permissions=274878286912
Expand Down
6 changes: 5 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
{
"name": "linkfix-for-discord",
"displayName": "LinkFix for Discord",
"description": "LinkFix is a Discord bot that replies to messages containing annoying links (Twitter, YouTube Shorts) with better ones (fxtwitter, youtu.be)",
"version": "1.0.0",
"keywords": ["discord", "discord.js", "discord-bot", "twitter", "fxtwitter", "vxtwitter", "youtube", "youtu.be", "youtube-shorts"],
"homepage": "https://podaboutli.st/discord",
"bugs": {
"url": "https://github.com/podaboutlist/linkfix-for-discord/issues",
"email": "git@podaboutli.st"
},
"license": "AGPL-3.0-or-later",
"author": {
"name": "Ralph",
"email": "ralph@podaboutli.st",
"url": "https://podaboutli.st/discord"
},
"repository": "github:podaboutlist/linkfix-for-discord",
"scripts": {
"build": "rm -rf dist && tsc",
"start": "node dist/index.js",
Expand Down

0 comments on commit 4c8877a

Please sign in to comment.