From: David Kerkeslager <kerkeslager@gmail.com>
Date: Fri, 14 Jan 2022 18:43:43 +0000 (-0500)
Subject: Flesh out the README
X-Git-Url: https://code.kerkeslager.com/?p=bigly;a=commitdiff_plain;h=994565ca5b8a8db77fbc7d89963bf2c391d8f01b

Flesh out the README
---

diff --git a/README.md b/README.md
index f4eda38..e1b64f8 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
 # bigly
-Make links big again
+## Make links big again!
+
+This is the opposite of bit.ly: instead of shortening URLs and hiding a bunch
+of tracking data in them, this tool follows redirects to get the full-length
+link, and *tries* to remove tracking parameters and cache results to shield
+further requests to the same URL from being trackable. Redirects are followed
+by our server, not your browser, so redirects collect our server's metadata
+rather than your browser's metadata. This isn't a comprehensive protection
+against all tracking, but I hope it can become one tool in a larger
+anti-tracking suite.
+
+No API is provided at this time, but ultimately this will be most useful if
+it has an API which allows it to be used in browser extensions.