Added basic README

This commit is contained in:
dangered wolf 2022-07-14 17:44:03 -04:00
parent 4e4a3f2f4a
commit 320a4d0411
No known key found for this signature in database
GPG key ID: 41E4D37680ED8B58

View file

@ -2,5 +2,25 @@
[![Webpack](https://github.com/dangeredwolf/pxtwitter/actions/workflows/webpack.yml/badge.svg)](https://github.com/dangeredwolf/pxtwitter/actions/workflows/webpack.yml)
### A TwitFix-like solution written in TypeScript and Cloudflare Workers, with support for polls, improved replies, and more.
## A TwitFix-like solution written in TypeScript for Cloudflare Workers. Embed videos, polls, and more!
![https://cdn.discordapp.com/attachments/165560751363325952/997256615365447680/pxtwitter.png](https://cdn.discordapp.com/attachments/165560751363325952/997256615365447680/pxtwitter.png)
✅ Embed Videos
✅ Embed Polls
✅ Embed Quote tweets
✅ Replace embedded t.co links with originals
✅ Creates media/pfp color-matching theme-color (looks great on Discord!)
✅ Private, we don't save tweets requested
### Things to tackle in the future
* Combining multiple images together
* Caching responses (I haven't done this yet as this is still being actively worked on!)
* Caching guest token (So we don't have to run to Twitter for a new one every request)