From 15c54680edc60494f5017b8f895609f9a42d1e2f Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 13:02:46 -0400 Subject: [PATCH 1/6] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19a1dac..3e53893 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Here's a little chart comparing features to Twitter default embeds and other embedding services -| | pxTwitter | Twitter default | vxTwitter | Twxtter | +| | pxTwitter | Twitter default | vxTwitter (BetterTwitFix) | Twxtter (sixFix) | |-------------------------------------|:------------------:|:------------------:|:--------------------------------:|:---------------------------------:| | Embed Tweets / Photos | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Embed Videos | :heavy_check_mark: | :x:¹ | :heavy_check_mark: | :heavy_check_mark: | @@ -43,6 +43,7 @@ Licensed under the permissive MIT license. Feel free to send a pull request! ### Things to tackle in the future +- A subdomain to directly embed images and videos, without embeds (thanks @TheAppleFreak!) - Combining multiple images together (would be outside CF Worker) - Caching guest token (So we don't have to bother Twitter for one on every request) From 4cf758ce2fdbca050bf48f0f791f64bc989988ba Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 14:00:18 -0400 Subject: [PATCH 2/6] Updated README with deployment info! --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3e53893..0a8008b 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ ✅ Private: We don't save tweets or their media (Outside of Cloudflare caching for speed) +-------------------- + Here's a little chart comparing features to Twitter default embeds and other embedding services | | pxTwitter | Twitter default | vxTwitter (BetterTwitFix) | Twxtter (sixFix) | @@ -39,11 +41,31 @@ Here's a little chart comparing features to Twitter default embeds and other emb ² pxTwitter and vxTwitter both ensure link privacy from the public. vxTwitter still stores all responses in a database / JSON file controlled by the owner. pxTwitter by contrast relies on Cloudflare caching of responses: there is no link store accessible to the owner +-------------------- + +## Why pxTwitter is better to develop for and deploy + +TwitFix and derivatives have quite a few dependencies you need to rely on. You need to set up a server somewhere, install Python all its dependencies, then either set up `youtube-dl` (resource intensive, relatively) or [beg Twitter for API access](https://twitter.com/dangeredwolf/status/1438983606135832581), and optionally set up a database, otherwise it uses the file system to cache. + +pxTwitter was written from the start as a lightweight, TypeScript-based Cloudflare Worker. Cloudflare Workers are completely free for up to 100,000 requests per day, per account. Cloudflare Workers are [fast to set up](https://developers.cloudflare.com/workers/get-started/guide/) and your script is distributed in their datacenters around the world for lower latency. + +pxTwitter does not need a database nor a Twitter API key: It takes a similar approach to `youtube-dl` where it pretends to be a logged-out Twitter web user, fetching a guest token and making API requests from there. As far as I can tell, this basically means we have "unlimited" read-only access to Twitter's API, including things they don't expose in their public API, useful for polls and other features. + +## Deploy pxTwitter yourself + +Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the pxTwitter directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). + +[Check Cloudflare's guide for additional info](https://developers.cloudflare.com/workers/get-started/guide/). + +Once you're set up with your worker on `*.workers.dev`, [add your worker to your custom domain](https://developers.cloudflare.com/workers/platform/routing/custom-domains/). + +-------------------- + Licensed under the permissive MIT license. Feel free to send a pull request! ### Things to tackle in the future -- A subdomain to directly embed images and videos, without embeds (thanks @TheAppleFreak!) +- A subdomain to directly link to a tweet's image/video, without embeds (thanks @TheAppleFreak!) - Combining multiple images together (would be outside CF Worker) - Caching guest token (So we don't have to bother Twitter for one on every request) From b050c8abf60cfacf27c9f3f29bdae3ee8d7bbd91 Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 14:02:03 -0400 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a8008b..7a45f50 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ pxTwitter does not need a database nor a Twitter API key: It takes a similar app ## Deploy pxTwitter yourself -Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the pxTwitter directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). +Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the repo directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). [Check Cloudflare's guide for additional info](https://developers.cloudflare.com/workers/get-started/guide/). From a6f89db3f9c21d426cc8cfa04260f39236ff9ca5 Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 14:02:50 -0400 Subject: [PATCH 4/6] Changed Cloudflare guide wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a45f50..a309024 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ pxTwitter does not need a database nor a Twitter API key: It takes a similar app Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the repo directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). -[Check Cloudflare's guide for additional info](https://developers.cloudflare.com/workers/get-started/guide/). +[Check Cloudflare's guide for additional info about getting started with workers](https://developers.cloudflare.com/workers/get-started/guide/). Once you're set up with your worker on `*.workers.dev`, [add your worker to your custom domain](https://developers.cloudflare.com/workers/platform/routing/custom-domains/). From 26595ce5d1528dacf514a43b9fe892e378cbc9c4 Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 14:06:22 -0400 Subject: [PATCH 5/6] Changed checkmark style --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a309024..c0d3012 100644 --- a/README.md +++ b/README.md @@ -10,17 +10,17 @@ ![https://cdn.discordapp.com/attachments/165560751363325952/997386462343462972/pxtwitter.png](https://cdn.discordapp.com/attachments/165560751363325952/997386462343462972/pxtwitter.png) -✅ Embed Videos (Twitter videos, and compatible external providers, such as YouTube) +:heavy_check_mark: **Embed Videos** (Including Twitter videos and compatible external providers, such as YouTube) -✅ Embed Poll results +:heavy_check_mark: **Embed Poll results** -✅ Embed Quote tweets (Including their media, if it doesn't conflict with the linked tweet) +:heavy_check_mark: **Embed Quote Tweets** (Including their media, if it doesn't conflict with the linked tweet) -✅ Replace embedded t.co links with originals +:heavy_check_mark: **Replace embedded t.co shortener with original links** -✅ Creates media/profile picture color-matching theme-color (looks great on Discord!) +:heavy_check_mark: **Creates media/profile picture color-matching theme-color** (looks great on Discord!) -✅ Private: We don't save tweets or their media (Outside of Cloudflare caching for speed) +:heavy_check_mark: **Better privacy: We don't save tweets or their media** (Outside of temporary Cloudflare caching for speed) -------------------- From 46a0fac81beb2ffbea7fac705e1ff54ea8b41072 Mon Sep 17 00:00:00 2001 From: dangered wolf Date: Fri, 15 Jul 2022 14:12:23 -0400 Subject: [PATCH 6/6] More README changes --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c0d3012..c70c66a 100644 --- a/README.md +++ b/README.md @@ -39,13 +39,13 @@ Here's a little chart comparing features to Twitter default embeds and other emb ¹ Discord will attempt to embed Twitter's video player, but it is unreliable -² pxTwitter and vxTwitter both ensure link privacy from the public. vxTwitter still stores all responses in a database / JSON file controlled by the owner. pxTwitter by contrast relies on Cloudflare caching of responses: there is no link store accessible to the owner +² Neither pxTwitter or vxTwitter have a public embed ledger, for privacy reasons. vxTwitter still stores all responses in a database / JSON file controlled by the owner. pxTwitter by contrast relies on Cloudflare caching of responses: there is no link store accessible to the owner. -------------------- ## Why pxTwitter is better to develop for and deploy -TwitFix and derivatives have quite a few dependencies you need to rely on. You need to set up a server somewhere, install Python all its dependencies, then either set up `youtube-dl` (resource intensive, relatively) or [beg Twitter for API access](https://twitter.com/dangeredwolf/status/1438983606135832581), and optionally set up a database, otherwise it uses the file system to cache. +TwitFix and derivatives have quite a few dependencies you need to rely on. You need to set up a server somewhere, install Python, all its dependencies, then either set up `youtube-dl` (more resource intensive) or [beg Twitter for API access](https://twitter.com/dangeredwolf/status/1438983606135832581), and optionally set up a database, otherwise it uses the file system to cache. pxTwitter was written from the start as a lightweight, TypeScript-based Cloudflare Worker. Cloudflare Workers are completely free for up to 100,000 requests per day, per account. Cloudflare Workers are [fast to set up](https://developers.cloudflare.com/workers/get-started/guide/) and your script is distributed in their datacenters around the world for lower latency. @@ -55,13 +55,13 @@ pxTwitter does not need a database nor a Twitter API key: It takes a similar app Clone the repo, install [Node.js](https://nodejs.org/) and run `npm install` in the repo directory. Copy `wrangler.example.toml` to `wrangler.toml` and add your [Cloudflare account ID](https://developers.cloudflare.com/fundamentals/get-started/basic-tasks/find-account-and-zone-ids/), and change the name of your worker if you need to. Authenticate with Cloudflare with `npx wrangler login`, then do `npx wrangler publish` (or `npm run publish`). -[Check Cloudflare's guide for additional info about getting started with workers](https://developers.cloudflare.com/workers/get-started/guide/). +[If you have more questions about setting up Cloudflare Workers, check out their Getting Started guide](https://developers.cloudflare.com/workers/get-started/guide/). Once you're set up with your worker on `*.workers.dev`, [add your worker to your custom domain](https://developers.cloudflare.com/workers/platform/routing/custom-domains/). -------------------- -Licensed under the permissive MIT license. Feel free to send a pull request! +**Licensed under the permissive MIT license. Feel free to send a pull request!** ### Things to tackle in the future