Create README.md

ben-aslan · Dec 8, 2024 · d48bcf5 · d48bcf5
1 parent 3d67f9d
commit d48bcf5
Showing 1 changed file with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,41 @@
+<center>
+
+# Smart Home Server
+
+<b>MQTT and Telegram [SmartHome](https://github.com/ben-aslan/SmartHome)</b><br>
+<sub>(Tested on Ubuntu 22.04 & 24.04)</sub>
+
+</center>
+
+<hr>
+
+## Table of Contents
+
+- [Installation](#installation)
+
+## Installation
+
+Installation with docker:
+
+Install docker
+
+```bash
+curl -fsSL https://get.docker.com | sh
+```
+
+```bash
+mkdir /opt/SmartHomeServer
+cd /opt/SmartHomeServer
+```
+
+```bash
+curl -O -L "https://raw.githubusercontent.com/ben-aslan/SmartHomeServer/Main/docker-compose.yml";
+```
+
+```bash
+mkdir Logs
+```
+
+```bash
+docker compose up -d
+```