From e808cd3a77cbe5b910ac03e70af13688c6b7e01e Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Sat, 14 Aug 2021 15:39:53 +0200
Subject: [PATCH] Added readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e5b1a9d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+<p align="center">
+  <img height="150" src="./icon_128.png">
+  <h1 align="center">LinkyLinky 4 Chrome</h1>
+  <h3 align="center">A simple, privacy focused urls shortner</h3>
+</p>
+
+<!-- ## 👀 Preview
+TODO: -->
+
+## ⚡ Installation
+- [Download project archive](https://git.odit.services/kauft.es/linkylinky/archive/main.zip)
+- Unzip the project
+- Go to [Chrome Extensions](chrome://extensions/) (`chrome://extensions/`)
+- Turn on `Developer Options` in the top right
+- Click on `Load Unpacked` in the top left
+- Select the project folder (contains this file)
+
+## 🏴 Roadmap/ Progress
+- [x] Basic README
+- [x] Publish to git
+- [x] Basic functionality
+    - [x] Create generated urls
+    - [x] Create custom urls
+    - [x] Copy shorturl to deskop
+    - [x] Notify on copy
+    - [x] Generate another url
+- [ ] Project Logo™
+- [ ] Finalize styling
\ No newline at end of file