From 82daba3ebe84a17735b4b90320a12896244703a3 Mon Sep 17 00:00:00 2001
From: Arthur Danjou <arthurdanjou@outlook.fr>
Date: Sun, 18 Apr 2021 17:21:32 +0200
Subject: [PATCH] Add readme and license

---
 LICENSE   | 21 +++++++++++++++++++++
 ReadMe.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 63 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 ReadMe.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e8c1050
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2021 © Arthur Danjou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 0000000..82764fc
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,42 @@
+# ArtClick 🔗
+
+This is my personal URL Shortener.
+
+Hosted version: [**artclick.fr**](https://artclick.fr) *(Soon)*
+
+## Features ✨
+
+- Create an unique short code to redirect to a very long link.
+- Caching with Redis to do not duplicate visit counts and to save resources.
+- Authentication with AdonisJs to secure the entries.
+- Visit Counts to have a few stats
+
+## Tech used ⚙
+
+- AdonisJs (HTTP Server & Authentication)
+- Redis (Caching)
+- MariaDB (Database)
+- Kubernetes + Docker (Deployment) *(Soon)*
+
+## Usage 📚
+
+- Authentication
+  - https://artclick.fr/auth/login ➡ Login
+  - https://artclick.fr/auth/logout ➡ Logout
+- Options
+  - https://artclick.fr/options/create ➡ Create a new shortened link
+  - https://artclick.fr/options/update ➡ Update a shortened link
+  - https://artclick.fr/options/delete ➡ Delete a shortened link
+- Links
+  - https://artclick.fr/ ➡ Get all links with informations
+  - https://artclick.fr/(code) ➡ Redirect to the shortened link's target
+  - https://artclick.fr/(code)/count ➡ Get the shortened link's visit count
+
+## Author 👤
+➡ Arthur Danjou : Developer
+- Twitter : [@ArthurDanj](https://twitter.com/ArthurDanj)
+- GitHub : [@ArthurDanjou](https://github.com/ArthurDanjou)
+
+## License 📑
+Copyright © 2020 - [@ArthurDanj](https://arthurdanjou.fr) \
+This project is [MIT](https://github.com/ArthurDanjou/artclick/blob/master/LICENSE) Licensed.