From e258a0d061e4d3d180d2e81fedd3d9af989588bd Mon Sep 17 00:00:00 2001
From: dogeystamp <dogeystamp@disroot.org>
Date: Fri, 10 Mar 2023 18:31:25 -0500
Subject: [PATCH] README.md: added

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ca2531e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# sachet
+
+sachet is a small file share server.
+
+## development
+
+To start sachet in development mode:
+
+Clone the repo.
+
+```
+git clone https://github.com/dogeystamp/sachet
+cd sachet
+```
+
+Create a venv with required dependencies:
+
+```
+python -m venv venv
+source venv/bin/activate
+python -m pip3 install -r requirements.txt
+```
+
+Start Flask in development mode:
+
+```
+flask --debug --app sachet.server run
+```
+
+### tests
+
+Tests are available with the following command:
+
+```
+pytest --cov --cov-report term-missing
+```