Update readme

Author: dryas

README.md

@@ -1 +1,34 @@
 # LazSimpleHTTPsGet
+
+![Example Application](https://github.com/dryas/LazSimpleHTTPsGet/blob/main/doc/example_screenshot.png)
+
+LazSimpleHTTPsGet is a simple asynchronous (threads) file download unit with progress indicator. It supports downloads from http and https sources as well and the developer can choose if he wants to use Ararat Synapse or Free Pascal/FCL based TFPHttpClient. It supports OpenSSLv1 and OpenSSLv3.
+
+## Synapse vs. TFPHttpClient:
+
+At the moment of writing the official stable version of FPC (3.2.x) only supports SSL v1.1.x which is end of life since January 24, 2024. If you want to get SSL v3 running with the TFPHttpClient based integration, you need to switch over to the most recent trunk version of FPC (3.3.x) which supports SSL v3. As it's not an option for everyone to switch their development environment over to a (potentially) unstable trunk version you can simply switch to Ararat Synapse by an compiler flag which offically supports SSL v3.
+
+## Where to get the OpenSSL DLLs?
+
+If you don't want to compile the DLLs by yourself, you can, for example, download them from the following location: [FireDaemon OpenSSL](https://kb.firedaemon.com/support/solutions/articles/4000121705-openssl-binary-distributions-for-microsoft-windows "FireDaemon OpenSSL")
+
+## How to install?
+
+Simply drop in the lazsimplehttpsget.pas unit in to your project and take care that the FCL or Synapse is linked as a requirement to the project.
+
+## Where do I get the requirements?
+
+FCL is shipped as part of the Free Pascal Compiler, so you don't need to install anything. Simply add the FCL as a requirement to your project.
+For Synapse you can install it using FpcUpDeluxe or download it from their GitHub account: [Ararat Synapse](https://github.com/geby/synapse "Ararat Synapse")
+
+![Example Application](https://github.com/dryas/LazSimpleHTTPsGet/blob/main/doc/setrequirements.png)
+
+## How to switch between FCL and Synapse?
+
+You can simply add a compiler option to your project. By default (so nothing specified) the unit will use FCL. If you want to use Synapse simply add "-dSIMPLEGETSYNAPSE" to your custom compiler options.
+
+![Compiler Options](https://github.com/dryas/LazSimpleHTTPsGet/blob/main/doc/compileroption.png)
+
+## I found a bug or have some ideas to improve it!
+
+I'm not a Pascal expert, even if I use it for years here and then. If you found a bug or you want to improve the unit, please fill an Issue or Pull request. Any help is appreciated.