From 91b9dcf22d63140dc5ae17a091f8bfe5312d3f14 Mon Sep 17 00:00:00 2001
From: Thomas Hyslop <thomas_dev@noreply.localhost>
Date: Tue, 30 Sep 2025 16:19:42 +0200
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index e69de29..8e235a7 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,42 @@
+
+# Eduvos Books
+
+A simple web app allowing users to download PDF books for their subjects.
+
+
+
+## Note
+
+No textbooks are included in this git repo. All books are stored in the folder `files`, seperated into subfolders for each subject. 
+
+
+## Setup and installation
+
+NodeJS and NPM are required (NPM should be packaged with standard NodeJS install)
+[https://nodejs.org/en]
+
+Clone the project onto your local machine with
+
+```bash
+  git clone https://git.bttstudios.co.za/Thomas_Dev/Eduvos-Books.git
+```
+
+Install required project files with
+
+```bash
+  cd {project_location}
+  npm install
+```
+
+Create your `files` location, and populate it with your files (can be within subfolders) 
+
+```bash
+  mkdir files
+``` 
+
+Launch the project by running 
+
+```bash
+  node app.js
+```    
+