docs: update README

README.md

@@ -1,5 +1,83 @@
-# ironmount
+<div align="center">
+  <h1>Ironmount</h1>
+  <h3>Keep your volumes in check!<br />One interface to manage all your storage</h3>
+  <a href="https://github.com/nicotsx/ironmount/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/nicotsx/ironmount" />
+  </a>
+  <br />
+  <figure>
+    <img src="https://github.com/nicotsx/ironmount/blob/main/screenshots/volume-details.png?raw=true" alt="Demo" />
+    <figcaption>
+      <p align="center">
+        Volume details view with usage statistics and health check status
+      </p>
+    </figcaption>
+  </figure>
+</div>
 
-docker run --rm -it -v nicolas:/data alpine sh -lc 'echo hello > /data/hi && cat /data/hi'
+<br />
 
-mount -t davfs http://192.168.2.42 /mnt/webdav
+## Intro
+
+Ironmount is an easy to use web interface to manage your remote storage and mount them as local volumes on your server. Docker as a first class citizen, Ironmount allows you to easily mount your remote storage directly into your containers with few lines of code.
+
+### Features
+
+https://github.com/nicotsx/ironmount/blob/main/screenshots/volume-creation.png?raw=true
+
+- ✅&nbsp; Support for multiple protocols: NFS, SMB, FTP, Directory
+- 📡&nbsp; Mount your remote storage as local folders
+- 🐳&nbsp; Docker integration: mount your remote storage directly into your containers via a docker volume syntax
+- 🔍&nbsp; Keep an eye on your mounts with health checks and automatic remounting on error
+- 📊&nbsp; Monitor your mounts usage with detailed statistics and graphs
+
+### Coming soon
+
+- 🔐&nbsp; User authentication and role management
+- 💾&nbsp; Automated backups and snapshots with encryption, strategies and retention policies
+- 🔄&nbsp; Re-exporting your mounts to other protocols (e.g. mount an FTP server as an SMB share with fine-grained permissions)
+- ☁️&nbsp; Integration with cloud storage providers (e.g. AWS S3, Google Drive, Dropbox)
+- 🔀&nbsp; Storage sharding and replication for high availability and performance
+
+## Installation
+
+In order to run Ironmount, you need to have Docker and Docker Compose installed on your server. Then, you can use the provided `docker-compose.yml` file to start the application.
+
+```yaml
+services:
+  ironmount:
+    image: nicotsx/ironmount:v0.0.1
+    container_name: ironmount
+    restart: unless-stopped
+    cap_add:
+      - SYS_ADMIN
+    ports:
+      - "4096:4096"
+    devices:
+      - /dev/fuse:/dev/fuse
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+      - /run/docker/plugins:/run/docker/plugins
+      - /var/lib/docker/volumes/:/var/lib/docker/volumes:rshared
+      - ironmount_data:/data
+
+volumes:
+  ironmount_data:
+    driver: local
+```
+
+Then, run the following command to start Ironmount:
+
+```bash
+docker-compose up -d
+```
+
+Once the container is running, you can access the web interface at `http://<your-server-ip>:4096`.
+
+## Docker volume usage
+
+![Preview](https://github.com/nicotsx/ironmount/blob/main/screenshots/docker-instructions.png?raw=true)
+
+## Volume creation
+
+![Preview](https://github.com/nicotsx/ironmount/blob/main/screenshots/volume-creation.png?raw=true)