From dcf4b76a42b1f830444ff718cf5f679c1c9bbfac Mon Sep 17 00:00:00 2001
From: AeternusDio <longnecklion126@gmail.com>
Date: Tue, 27 Aug 2024 17:38:41 -0700
Subject: [PATCH] =?UTF-8?q?=E2=9C=85=20Updated=20README=20and=20added=20In?=
 =?UTF-8?q?stall=20file?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md  | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 install.sh | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 86 insertions(+), 2 deletions(-)
 create mode 100644 install.sh

diff --git a/README.md b/README.md
index dc3443d..fa2ed6c 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,51 @@
-# sftm
-A fast🚀 easy to use Todo Manager in Rust 🦀
+# sftm (Super Fast Todo Manager)
+By Aeternus • *At* QUAKTECH
+
+<img src="https://avatars.githubusercontent.com/u/170379778?s=200&v=4" alt="QUAKTECH" width="100"/>
+
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+## 📋 Overview
+
+A fast🚀, easy Todo Manager made with Rust🦀 which will be apart of our up coming software suite.
+
+## 📜 Software License
+
+- *MIT License*
+
+## Authors ✍️
+- [Aeternus](https://github.com/Aeternusdio)
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+## ✨ Features
+
+- Fast 🚀
+- LightWight 💨
+
+
+## 📦 Instalation
+
+```Shell
+$ git clone https://github.com/QUAKTECH/sftm
+$ cd sftm
+$ chmod +x install.sh
+$ ./install.sh
+```
+Simple Idiot! 
+
+
+## 📖 Usage
+
+**Commands** : 
+- add - Add a Todo [ $ sftm add "Buy Bananas" groceries ]
+- list - List all Todos [ $ sftm list ]
+- remove - Remove a Todo [ $ sftm remove 1 ] (1 is the index of the Todo, you also use -f to delete a file : $ sftm remove -f groceries)
+- version - Show the version of the program [ $ sftm version ]
+- check - Check a Todo [ $ sftm check 1 ] (1 is the index of the Todo)
+- show - Show a Todo file [ $ sftm show groceries ]
+
+
+
+---
\ No newline at end of file
diff --git a/install.sh b/install.sh
new file mode 100644
index 0000000..4e6e146
--- /dev/null
+++ b/install.sh
@@ -0,0 +1,35 @@
+#!/bin/bash
+
+echo "Building project..."
+cargo build --release
+
+if [ $? -ne 0 ]; then
+    echo "Build failed. Exiting."
+    exit 1
+fi
+
+if [ ! -f target/release/sftm ]; then
+    echo "Error: target/release/sftm not found. Exiting."
+    exit 1
+fi
+
+TEMPLATE_TARGET_PATH="/home/$USER/.local/share/LICENSER/"
+mkdir -p "$TEMPLATE_TARGET_PATH"
+mv Templates/ "$TEMPLATE_TARGET_PATH"
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    echo "Detected macOS. Copying sftm to /usr/local/bin..."
+    sudo cp target/release/sftm /usr/local/bin/
+    INSTALL_PATH="/usr/local/bin/sftm"
+else
+    echo "Copying sftm to /usr/bin..."
+    sudo cp target/release/sftm /usr/bin/
+    INSTALL_PATH="/usr/bin/sftm"
+fi
+
+if [ $? -ne 0 ]; then
+    echo "Failed to copy sftm to $INSTALL_PATH. Exiting."
+    exit 1
+fi
+
+echo "sftm has been installed.🔥"
\ No newline at end of file