From 872155aac5f70202f83ba27a8cceb47c6cbb9154 Mon Sep 17 00:00:00 2001
From: DAVID Axel <axel.david@etu.univ-amu.fr>
Date: Wed, 3 May 2023 09:13:36 +0200
Subject: [PATCH] docs: :memo: Update INSTALL.md and README

---
 INSTALL.md | 31 ++++++++++---------------------
 README.md  |  2 +-
 2 files changed, 11 insertions(+), 22 deletions(-)

diff --git a/INSTALL.md b/INSTALL.md
index 5a5d364..2c576e8 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -64,7 +64,7 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
 ## Run the API :
 
 ```shell
-python3 -m vigenere-api
+python3 -m vigenere_api
 ```
 
 # Development :
@@ -154,40 +154,29 @@ poetry update
 ## Run the API :
 
 ```shell
-poetry run start
+python -m vigenere_api
 ```
 
-## Build the API package :
-
-```shell
-poetry build
-```
-
-## Bump version :
-
-You can bump a new version of the package.<br>
-The script increases the version of the package, and creates a new tag.<br>
-You need to push tag, like:
+## Execute tests :
 
 ```shell
-git push --tags
+PYTHONPATH=.src pytest
 ```
 
-### Major version :
+## Execute coverage :
 
 ```shell
-poetry run bump-major-version
+PYTHONPATH=.src pytest --cov=src --cov=tests --cov=src --cov=tests --junit-xml=coverage.xml --cov-report=html:coverage_html
 ```
 
-### Minor version :
+## Execute integration tests :
 
 ```shell
-poetry run bump-minor-version
+PYTHONPATH=.src pytest --with-integration
 ```
 
-### Patch version :
+## Build the API package :
 
 ```shell
-poetry run bump-patch-version
+poetry build
 ```
-
diff --git a/README.md b/README.md
index 6958295..f27a381 100644
--- a/README.md
+++ b/README.md
@@ -17,5 +17,5 @@ pip install https://etulab.univ-amu.fr/d19006523/vigenere-api/-/packages/pypi/vi
   You can run the API with an HTTP server like :
 
 ```shell
-python -m vigenere-api
+python -m vigenere_api
 ```
-- 
GitLab