Start writing readme.md

README.md

@@ -1,2 +1,36 @@
 # WebPicDownloader
 
+## What is webpicdownloader ?
+
+WebPicDownloader is a scraping tool that allows you to download all the images of a website. Basically WebPic is a Python script around which a graphical interface has been added to make it easier to use.
+
+You will find [here](#windows-application) utility information to use the Windows application ``WebPicDownloader.exe``. And [here](#use-python-script) information to use or implement the Python script ``WebPicDownloader.py`` in your application (without the graphical interface).
+
+## Windows application
+
+To use WebPic on windows nothing more simple, download the executable ``.exe`` of the last [release here](https://git.endmove.eu/EndMove/WebPicDownloader/releases) (be careful to download the latest release and not a pre-release).
+
+Execute the file ``WebPicDownloader.exe`` and enjoy it! 👌
+
+## Use Python script
+
+To start, find the script to use or to add to your code [here](model/WebPicDownloader.py).
+
+### Requirements
+
+To use the script check the following prerequisites.
+
+* Python `>= 3.10.6` ;
+* bs4 (BeautifulSoup) `>= 0.0.1` ;
+
+### Console Use ?
+
+If you just want to use the console version of the script without the built-in GUI then you just need to check the [prerequisites](#requirements) and run the script as follows:
+
+```python
+python3 WebPicDownloader.py
+```
+
+### Integration to your code ?
+
+First of all you have to know that WebPic has a deamon worker that downloads all the images asynchronously (this allows you not to block your program when a download is in progress). This same worker will be automatically killed as soon as your program finishes. WebPic therefore provides a blocking stop function allowing you to wait for the end of the download. See the information below.