From 146804b68add01fc3a8db028d37fe5d315193766 Mon Sep 17 00:00:00 2001
From: q3aql <q3aql@duck.com>
Date: Mon, 16 Dec 2024 21:14:35 +0100
Subject: [PATCH] README.md

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a739aac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+files-html - Cool indexer html for Apache/Nginx with Bootstrap
+==============================================================
+
+### Installation:
+
+  * **Download:**
+  
+    * Clone git repository:
+    
+          git clone https://git.q3aql.dev/q3aql/files-html
+
+  * **Set language and generate index:**
+  
+    * Run `set-lang.sh` to configure index language:
+    
+          cd files-html
+          chmod +x set-lang.sh
+          ./set-lang.sh <lang>
+      
+    * Copy your files inside `files` folder and run `make-html-browser.sh` script:
+    
+          chmod +x make-html-browser.sh
+          ./make-html-browser.sh
+
+    * Open `index.html` file and see your bootstrap index:
+
+    <img src="https://git.q3aql.dev/q3aql/files-html/raw/branch/master/img/files-html.png" />
+
+### External links:
+
+  * [Bootstrap](https://getbootstrap.com/)
+  * [Ubuntu font Homepage](https://design.ubuntu.com/font/)
+  * [HTML 5 Homepage](https://html.com/html5/)
+