Update README.md

README.md

@@ -1,2 +1,45 @@
 # QRaven
 A QGIS Plugin to help generate input files for Raven
+
+## Description
+
+QRaven aims to simplify the creation of the primary input file (.RVI) and HRU/Basin definition file (.RVH) for the Raven hydrological modelling framework. It allows the user to choose all the options for the RVI file (except for the hydrological processes at the moment) and it automates the setup, as well as the use of the BasinMaker python library.
+
+## Getting Started
+
+### Dependencies
+
+* QGIS (3.24 and above) must be installed. Prior versions may not work with the plugin
+* To use the BasinMaker options, Docker must be installed on your computer and properly configured. Linux users must make sure to follow the post-installation steps provided by Docker
+* QRaven works on Linux and should work on Windows and Mac as well
+
+### Installing
+
+* Go to the releases page and dowload the .zip file : https://github.com/Scriptbash/QRaven/releases
+* Open QGIS, go to "Plugins", click on "Manage and Install plugins". Finally, click on the "Install from ZIP" menu, select the dowloaded .zip file and click on "Install"
+
+### How to use QRaven
+
+* Click on the QRaven icon in your toolbar ![image](https://user-images.githubusercontent.com/98601298/162262632-ead9b9aa-2034-4e5b-bba2-859040995ed5.png) or go in the "Plugins" menu, select the QRaven option and click on "Generate Raven input files"
+* You will have two main tabs
+  * Raven RVI
+  * BasinMaker RVH  
+
+* Raven RVI tab
+  * Use this tab to create your RVI file. The plugin __does not__ validate your inputs, meaning that the RVI file generated may not work in Raven if the configuration you make is invalid
+  * Select and enter all the information you want to add inside the RVI file. Once your are done, click on the "Write" button to generate the RVI file. Make sure to have selected a valid directory inside the "Output Directory" field and that you have write permissions to it
+  * Screenshots
+    *  ![image](https://user-images.githubusercontent.com/98601298/162264611-48160e69-9435-49f0-ae0f-5b6d912644d5.png)
+    *  ![image](https://user-images.githubusercontent.com/98601298/162264955-e076fcb2-9c10-4fd6-981e-1472dcf7ae60.png)
+* BasinMaker RVH tab
+  * Use this tab to lauch BasinMaker and generate the RVH files
+  * This section is still in development, coming soon... 
+
+
+
+
+
+
+## Help
+
+If you run into any issue, question or feedback while using QRaven, please open an issue here : https://github.com/Scriptbash/QRaven/issues