From 320a4d04112168e010501107378782cb7d1b343f Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Thu, 14 Jul 2022 17:44:03 -0400 Subject: [PATCH] Added basic README --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ac74c26..079004a 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file