From bcf36fc6838aec4c903ad07bc7d9310d0738ee62 Mon Sep 17 00:00:00 2001 From: Mark Suckerberg Date: Sat, 29 Jun 2024 16:43:43 -0500 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5985c9e..488046e 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# Readme Pending +# TxTumblr Tumblr Unofficial Embedding Helper + +## ⚠️ Notice ⚠️ + +This tool is **NOT** official, endorsed, sponsored by, or otherwise associated with Tumblr in any way, shape, or form. + +## The Project + +This project aims to create a tool for embedding multiple-image and multiple-post Tumblr content on Discord and similar sites that use OpenGraph information for creating embeds. It uses the Tumblr API to fetch the information, and simply sends a barebones HTML page with all the information necessary for an informational embed as well as a redirect meta tag so that if you were to go to the page in a browser, you'd be immediately redirected to the actual post. + +## Usage + +Simply replace `tumblr.com` in links with `txtumblr.com`. This works for URLS formatted as `https://tumblr.com/USERNAME/POSTID` and `https://USERNAME.tumblr.com/POSTID`. Simply prepend "tx" to the tumblr on any post and it will attempt to fetch the information. Posts that would require a login to access cannot be embedded, but the tool will return embed information with an error that says as much. + +## How to self-host (WIP) + +1. Register a tumblr app [here](https://www.tumblr.com/oauth/apps) +2. Get a [Cloudflare](https://cloudflare.com/) account if you don't already have one +3. [Install Wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/) (used to deploy the code) +4. Replace the consumer key in `wrangler.toml` with the one from your Tumblr app +5. Create a cloudflare worker with an environment secret of `TUMBLR_CONSUMER_SECRET` set to the secret key from your Tumblr app +6. Use like you would the main application