From ed5ca366fe192ed5a2221f34f9e81e09e88f5eab Mon Sep 17 00:00:00 2001
From: Joseph Ferano <joseph@ferano.io>
Date: Sat, 20 May 2023 14:39:55 +0700
Subject: [PATCH] Added License and WIP Readme

---
 LICENSE      | 20 ++++++++++++++++++++
 README.org   | 16 ++++++++++++++++
 project.todo |  5 +++--
 3 files changed, 39 insertions(+), 2 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 README.org

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..9061e72
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2023 Joseph Ferano - joseph@ferano.io
+
+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.
\ No newline at end of file
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..68ba0ae
--- /dev/null
+++ b/README.org
@@ -0,0 +1,16 @@
+# -*- org-src-preserve-indentation: t; olivetti-mode: t -*-
+#+TITLE: Zip My Link
+#+AUTHOR: Joseph Ferano
+
+* About
+
+This is a standard URL Shortening service built to practice web development.
+Currently it works at providing the most basic feature which is to give the user
+a shorter version of a URL they provide and then redirecting the user to the
+site when consuming the link.
+
+** What I'm using
+- Python 3.11
+  - FastAPI
+- CouchDB
+- ~podman~ and ~podman-compose~
diff --git a/project.todo b/project.todo
index de88bbf..b754254 100644
--- a/project.todo
+++ b/project.todo
@@ -11,8 +11,9 @@
 - [X] Add DNS records
 - [X] Add to nginx.conf
 - [X] Generate certbot SSL cert
-* TODO Create a README.org
-* TODO Add MIT license
+* DONE Add MIT license
+* INPROGRESS Create a README.org
+
 
 * BACKLOG RTFM on how to create a container network
 * BACKLOG Gitea Actions