From 86955e8e409c6540bf0f73c4ba0d7e28ac923422 Mon Sep 17 00:00:00 2001
From: xrando <2837341L@student.gla.ac.uk>
Date: Wed, 1 Nov 2023 11:53:22 +0800
Subject: [PATCH] initial readme

initial readme
---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc77c3b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Safe Share
+
+## Installation
+
+```bash
+# Clone the repository
+python -m venv venv
+
+## On linux
+source venv/bin/activate
+
+## On Windows
+venv\Scripts\activate
+
+cd safeshare
+pip install -r requirements.txt
+```
+
+## Usage
+
+```bash
+# Run backend using docker-compose
+docker-compose up
+```
+
+## Endpoints
+
+- `/admin/` - Admin Panel
+- Additional Endpoints can be found in [Routes.md](./study_together/study_together_app/Routes.md)