readme: added screenshots, video, installation, usage and other usefu…

…l information

README.md

@@ -1,28 +1,86 @@
 # SiteOne Crawler GUI
 
-The best and easy-to-use multi-functional web crawler, offline exporter and analysis tool you'll love :)
+This is a desktop application to very useful command-line tool [SiteOne Crawler](https://github.com/janreges/siteone-crawler) and is ready for all major platforms - **Windows (x64)**, **macOS (x64, arm64)** and **Linux (x64, arm64)**.
 
-## Recommended IDE Setup
+The goal of this desktop application is to **enable comfortable use** of SiteOne Crawler even for users without the need to work with the command line.
 
-- [VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode)
+More info: https://crawler.siteone.io/
 
-## Project Setup
+## Screenshots and video
 
-### Install
+![SiteOne Crawler Demo](docs/app-demo-2023-12-04.gif)
+![SiteOne Crawler Full Form](docs/screenshot-2-app-full-form.png)
+
+### HTML report video
+
+[![SiteOne Crawler HTML report video](https://img.youtube.com/vi/vMy1umO9Prc/0.jpg)](https://www.youtube.com/watch?v=vMy1umO9Prc)
+
+## Step 1 - Installation
+
+1. **Go** to the [releases](https://github.com/janreges/siteone-crawler-gui/releases) section.
+2. **Download** the latest ready version of the installer for your platform (Windows, macOS, Linux).
+3. **Install** the application.
+
+## Step 2 - Usage
+1. **Run** the installed application - you can find it in your system under the name `SiteOne Crawler`.
+2. **Enter** the URL of your website.
+3. **Set** optional options. Regular users will be fine with the basic configuration form. Advanced users can also use the form for full settings, **without limiting the values**. The content of these 2 forms is synchronized so **you can use them both**.
+4. **Start** crawling.
+5. **Wait** for the crawling to finish.
+6. On the `Result` tab, you can **open** a detailed **HTML report** or download the report as **JSON** or **TXT**. If you have set, you can view the **generated offline version** of your website or download the **sitemap** xml/txt files.
+7. **Take a look** at the website [crawler.siteone.io](https://crawler.siteone.io/?utm_source=github-gui-readme) and study [all the possibilities of use](https://crawler.siteone.io/introduction/key-features/#list-of-features).
+8. **Enjoy the tool** and [send us feedback](https://crawler.siteone.io/introduction/contact-and-community/) if you have suggestions for improvement.
+
+
+## For Developers
+
+### Important note
+
+This app was written over several evenings with an **emphasis on useful functionality** and **ease of use**. Both the functionality and the graphical interface were developed continuously.
+
+The structure of the **code is not optimal** and the components are not ideally distributed. Sharing state between components is also not optimal.
+
+In the next versions, **refactoring** will take place with the aim of better dividing the responsibilities of individual components.
+
+If anyone is interested in **helping with the development**, please open an issue on GitHub. However, I would like to implement other functionalities only after the mentioned refactoring.
+
+### Tech Stack
+
+- [Electron](https://www.electronjs.org/) as a desktop app framework
+- [Svelte](https://svelte.dev/) as a JS framework
+- [TypeScript](https://www.typescriptlang.org/) for type checking
+- [Vite](https://vitejs.dev/) as a bundler
+- [daisyUI](https://kit.svelte.dev/) and [Tailwind CSS](https://tailwindcss.com/) for UI
+- [SiteOne Crawler](https://github.com/janreges/siteone-crawler) as a command-line tool for crawling, generating reports or offline versions of websites
+
+### Installation
 
 ```bash
-$ npm install
+# checkout repository
+git checkout https://github.com/janreges/siteone-crawler-gui.git
+cd siteone-crawler-gui
+
+# initialize and download submodule with command-line SiteOne Crawler into src/siteone-crawler
+git submodule update --init --recursive
+
+# install dependencies
+npm install
 ```
 
 ### Development
 
 ```bash
+# run development server - it will open an Electron app with hot-reloading
 $ npm run dev
 ```
 
 ### Build
 
+**Note**: In the first version, I did not emphasize the treatment of all problems reported by svelte-check. Therefore, to create a build, it is necessary to remove `npm run typecheck &&` from `build` script in `package.json`. If anyone wants to participate in the development of this GUI application, I will be happy for help and pull requests.
+
 ```bash
+# NOTICE: builds have to be run on the target platform
+
 # For Windows (x64)
 $ npm run build:win-x64
 
@@ -38,3 +96,5 @@ $ npm run build:linux-x64
 # For Linux (arm64)
 $ npm run build:linux-arm64
 ```
+
+SiteOne Crawler website: https://crawler.siteone.io/