diff --git a/extension/README.md b/extension/README.md index c5dc95f..52b1633 100644 --- a/extension/README.md +++ b/extension/README.md @@ -1,2 +1,14 @@ -# Unshorten -A Firefox extension to unshorten links from sites like Twitter. \ No newline at end of file +# Unshortener +A Firefox extension to reveal links behind URL shorteners like Twitter and TinyURL. + +**Supported sites:** +- t.co +- tinyurl.com + +## Usage +Build the extension and install it in Firefox. Right-clicking links will reveal a new +"Unshorten link" option which will resolve the link and copy it to the clipboard. + +```shell +make zip +``` \ No newline at end of file diff --git a/server/README.md b/server/README.md index a9982bb..3e7f2f7 100644 --- a/server/README.md +++ b/server/README.md @@ -1,2 +1,14 @@ -# Unshorten Server -Simple FastAPI app to unshorten URLs. \ No newline at end of file +# Unshortener Resolver API +Simple FastAPI app to resolve links behind shortened URLs. + +**Supported sites**: +- t.co +- tinyurl.com + +## Usage +Build and run the Docker container: + +```shell +make build +docker -d --name unshortener -p 8000:8000 unshortener-api +``` \ No newline at end of file