From 697ba4b100c26f5592802fabf0ab3eeea5113d3d Mon Sep 17 00:00:00 2001
From: alyssadev <alyssa.dev.smith@gmail.com>
Date: Sun, 17 Sep 2023 04:58:17 +1000
Subject: [PATCH] added readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05e7c86
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+linkie
+======
+
+A simple url shortener. Largely adapting [VandyHacks/vhl.ink](https://github.com/VandyHacks/vhl.ink) with the aim of providing a more ptpb-like experience (i.e the fewest keystrokes from a cli possible while still being reasonably secure for private use)
+
+Deploying
+---------
+
+`wrangler deploy`
+
+Usage
+-----
+
+`curl -n -d u=http://example.com linkie/path` will make `http://linkie/path` 302 redirect to the provided url. use .netrc to store the auth username/password (inspired by ix.io)
+
+See test.py for more usage and test cases