First commit. Implemented collection of urls

1 files changed, 34 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..d6efc6d
--- /dev/null
+++ b/README.org
@@ -0,0 +1,34 @@
+#+title: traclicker
+#+author: Yuchen Pei <id@ypei.org>
+
+* Introduction
+  :PROPERTIES:
+  :UPDATED:  [2023-10-29 Sun 19:13]
+  :END:
+
+Click trackers are recipient-specific links in email newsletters which
+when clicked, registers the click with the sender's server and gets a
+the real link through http redirect (301/302). On top of the info that
+a server gains from a GET request like IP address and time of the
+request, the sender's server can also identify the email recipient who
+clicked the link because each recipient receives a unique link, and
+there are few ways to defend against such identification.
+
+Click trackers are a violation of privacy regardless of how the sender
+of the email tries to justify it. This program aims to mitigate the
+privacy risk for email recipients, by automatically sending a HEAD
+request to all links and collecting the real urls, and at the time
+when the recipient actually reads the mails, showing the real urls.
+
+This is a work in progress, and at this moment only the collection
+part has been implemented, for messages in maildirs.
+
+* Copyright and contact
+  :PROPERTIES:
+  :UPDATED:  [2023-10-29 Sun 19:15]
+  :END:
+
+~tracklicker~ is maintained by Yuchen Pei <id@ypei.org> and covered by
+[[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]]. You may find the license text in a file named
+COPYING.agpl3 in the project tree. For comments, bug reports or
+patches, please use the mailing list [[https://lists.sr.ht/~ycp/gym][~ycp/gym@lists.sr.ht]].