From 41e35e2e7b67fe18b8b3e95689631084d3566cf2 Mon Sep 17 00:00:00 2001
From: Dubtempo <dubtempo@rocketmail.com>
Date: Wed, 11 Aug 2021 18:21:52 -0700
Subject: [PATCH] ReadMe Updates

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++----
 1 file changed, 38 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index f4044f7..a011ba6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,39 @@
-# ClamCron
+# [ClamCron](https://gitea.dubtempo.com/DT/ClamCron)
 
-Script for scanning directories with ClamAV at regular intervals.
-
-*note -- this script does not setup the cronjob itself.
\ No newline at end of file
+Script for scanning directories with ClamAV at regular intervals.
+
+*note -- this script does not setup the cronjob itself.
+
+<br \>
+
+## Requirements
+
+Make sure all dependencies have been installed before using this script:
+
+* [ClamAV](https://www.clamav.net/) ~ tested on Ubuntu 18.04
+
+<br \>
+
+## Project Installation
+
+Install this project via git pull:
+
+```shell
+$ git clone https://gitea.dubtempo.com/DT/ClamCron.git
+```
+
+Make sure the script file is executable.
+
+```shell
+$ chmod u+x ClamCron.sh
+```
+
+<br \>
+
+## Project Usage
+
+To use this script, complete the following steps.
+
+1. Update the variables in the config file: _config/ClanCrom.conf_.
+
+1. Run the script manually or by referencing it via cronjob.
\ No newline at end of file