From 388cfbdc94ae25f6f95c196e1e046e73d99dbe50 Mon Sep 17 00:00:00 2001
From: Pierre VERBAERE <pierre@verbaere.com>
Date: Thu, 8 Sep 2022 00:15:50 +0200
Subject: [PATCH] Add README informations

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

diff --git a/README.md b/README.md
index 09dc2d9..debe16b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,41 @@
-# Python-Flask-Template
+# OpenSIRP-API
 
-Template pour créer une API REST en Python avec Flask, SQLAlchemy, Marshmallow et JWT pour l'authentification
\ No newline at end of file
+OpenSIRP is an OpenSource SIRP (Security Incident Response Plateform). This repository is the backend of the project.
+
+## Get Started
+
+### Requirements
+Before install backend, you need:
+- python 3.10+
+- python-pip
+
+
+### Install
+In command terminal:
+
+``` 
+git clone https://gitea.verbaere.com/openSIRP/openSIRP-API.git 
+cd openSIRP-API
+```
+
+*Optional (If you want run in python virtual env)*
+
+
+``` 
+python3 -m venv en 
+source env/bin/activate
+```
+
+Install lib with pip
+``` 
+pip install -r requirements.txt 
+```
+
+### Configure
+Open ```config.py``` file on set you personal settings
+
+### Run
+Launch the API
+``` 
+python -m flask run 
+```
\ No newline at end of file