add basic readme

This commit is contained in:
YK 2024-12-09 07:05:18 +03:00
parent 5d00b742a5
commit 245780cd2f
2 changed files with 22 additions and 0 deletions

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# TGX2: Make Your Likes Public Again
[WIP.]
TGX2 is a browser extension that allows you to send posts you like on Twitter ("""X""") to your Telegram channel/group/PM [of a user who allowed your bot to message them. Including yourself.]
Ridiculously over-engineered and build with Rust, WASM and whatnot by [yk](https://x.com/ymkeller).
## Installation:
- Download a zip archive for your browser and install it;
- Message @BotFather on Telegram to create your own bot and acquire token;
- Add bot to a group/chat that messages will be posted into, make sure that the bot is allowed to post there;
- Get said chat/group ID (Telegram Settings → Advanced → Experimental → Show Peer IDs, or use any 3rd-party bot that can give you an ID from a forwarded message);
- Fill token and group id fields in the extension popup, set other settings to your liking;
- Enjoy people being able to see your liked xweets so they can get mad at you again!
[](ui-preview.png)
## TODO
- [ ] Download and repost videos/media content on like if present, opt-in
- [ ] Write a better guide/readme, maybe record a screencast
- [ ] "Send your posts" feature, etc.

BIN
ui-preview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB