Updated readme

stfc · Feb 18, 2025 · 977bcea · 977bcea
1 parent d9577da
commit 977bcea
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
 # janus-web
 Web app for janus-core
+
+## Installation
+Clone the repository from Github and then install the dependencies with uv:
+```bash
+git clone [email protected]:stfc/janus-web.git
+uv sync
+```
+
+## Usage
+Start API with main:
+```bash
+python main.py
+```