diff --git a/README.md b/README.md index c480ae4..14b2f64 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@

A small url shortener, originaly developed for kauft.es

+## Features +* Url shortinging to 18-byte hex ids +* Special shortening "providers" for well-used services + +### Provider patterns + +| Provider | Pattern | Resolves to | Notes | +| - | - | - | - | +| YouTube (Video) | `/yt/id` | `https://youtu.be/id` | None | +| YouTube (Playlist) | `/ytpl/id` | `https://youtube.com/playlist?list=id` | Remember: Private playlists will result in user-side errors | +| Amazon | `/a/id` | `https://amazon.de/dp/id` | Recognizes all kind of cursed amazon urls (+smile and others) | +| eBay | `/e/id` | `https://ebay.de/itm/` | Only tested with German eBay | +| Reddit | `/r/id` | `https://redd.it/` | Powered by the awesome work of u/TheAppleFreak https://kauf.es/r/4vaqiw | + ## Dev Setup 🛠 > Runs on port 3000