new readme

README.md

@@ -1,36 +1,18 @@
-# microphone guardian 
-##  download the .exe from the dist/ folder
+# gaming voice guardian
 
 A tool to measure your microphone volume and play an alarm sound if you talk too loud.
 
+## Download 
 
-# WIP: Graphical Interface
+[download here](https://github.com/Novecento99/gaming-voice-guardian/releases/download/v1/soundMonitor.exe)
 
-![alt text](GUIv1.png)
-## Usage
-
-Python 3 is needed to run the source code. You can run the following command to install all the required modules:
-```
-python -m pip install -r requirements.txt
-```
-
-Then, just run the following command to start the program (or double click `Scimia.py`, if you have your Python configured to automatically run all `.py` extensions):
-```
-python Scimia.py
-```
-
-However, there is also a compiled binary in the `exe version` folder. You can run it by double clicking the `Scimia.exe` file.
+##  Graphical Interface
 
-The threshold is typically around `100`.
+![alt text](GUIv1.png)
 
 ## Contributing
 
 Pull requests and issues are welcome!  
 Feel free to submit any bugs you find.  
 If you want to help make this tool better, make a few commits and create a pull request.  
 Thank you! 😊
-
-## Background
-
-"_Just made this to let my house mates not being wake up by my playing at pc._"  
-~ Novecento99