refine README.md and add documentations

README.md

@@ -1,6 +1,58 @@
-```
-conda create -n faster-whisper-n-llm python=3.10
-conda activate faster-whisper-n-llm
-conda install nvidia::cudnn cuda-version=12
-```
-# faster-whisper-n-ionet-llm
+# FWAL WebUI (Faster Whisper And LLM WebUI) by swrneko
+
+<div align="center">
+  <img src="https://count.getloli.com/get/@swrneko-faster-whisper-n-ionet-llm?theme=rule34"/>
+</div>
+
+## Screenshots
+<div>
+  <div>
+    <p>Main panel</p>
+    <img src='src/1.png'/>
+  </div>
+  <div>
+    <p>faster-whisper settings menu</p>
+    <img src='src/2.png'/>
+  </div>
+  <div>
+    <p>io.net api settings menu</p>
+    <img src='src/3.png'/>
+  </div>
+</div>
+
+## Requirements
+  - python-conda or miniconda;
+  - python 3.10 or above;
+  - linux (windows not tested but probably working);
+
+  Python requirements are listed in `requirements.txt`.
+
+## Installation
+1. Clone repository:
+  ```
+  git clone https://github.com/swrneko/faster-whisper-n-ionet-llm.git
+  cd faster-whisper-n-ionet-llm
+  ```
+
+2. Create virtual env:
+  ```
+  conda create -n faster-whisper-n-ionet-llm python=3.10
+  conda activate faster-whisper-n-ionet-llm
+  conda install nvidia::cudnn cuda-version=12
+  ```
+
+3. Install requirements:
+  ```
+  pip install -r requirements.txt
+  ```
+
+4. Get api key from [io.net](https://ai.io.net/ai/api-keys) and insert into `.env` file (need to create it in root of repository directory).
+It should looks like this:
+  ```
+  API_KEY='your_api_key_without_qoutes'  
+  ```
+
+5. Done! Now you can just run it like that:
+  ```shell
+  python app.py
+  ```