docs: minor improvements (#160)

* docs: readme improvements

* docs: readme improvements

README.md

@@ -1,19 +1,35 @@
-# Iceberg
-
-Plex torrent streaming through Real Debrid and 3rd party services like Overseerr, Mdblist, etc.
-
-Rewrite of [plex_debrid](https://github.com/itsToggle/plex_debrid) project.
+<a align="center" href="https://github.com/dreulavelle/iceberg">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/dreulavelle/iceberg/main/assets/iceberg-dark.png">
+    <img alt="Iceberg" src="https://raw.githubusercontent.com/dreulavelle/iceberg/main/assets/iceberg-light.png">
+  </picture>
+</a>
+
+<div align="center">
+  <a href="https://github.com/dreulavelle/iceberg/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/dreulavelle/iceberg"></a>
+  <a href="https://github.com/dreulavelle/iceberg/issues"><img alt="Issues" src="https://img.shields.io/github/issues/dreulavelle/iceberg" /></a>
+  <a href="https://github.com/dreulavelle/iceberg/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/dreulavelle/iceberg"></a>
+  <a href="https://github.com/dreulavelle/iceberg/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/dreulavelle/iceberg" /></a>
+  <a href="https://discord.gg/wDgVdH8vNM"><img alt="Discord" src="https://img.shields.io/badge/Join%20discord-8A2BE2" /></a>
+</div>
+
+<div align="center">
+  <p>Plex torrent streaming through Real Debrid and 3rd party services like Overseerr, Mdblist, etc.</p>
+  <p>Rewrite of <a href="https://github.com/itsToggle/plex_debrid">plex_debrid project.</a></p>
+</div>
 
 Services currently supported:
-- [x] Real Debrid
-- [x] Plex
-- [x] Overseerr
-- [x] Mdblist
-- [x] Plex Watchlist RSS
-- [x] Torrentio
-- [x] Orionoid
-- [x] Jackett
-- [ ] and more to come!
+
+-   [x] Real Debrid
+-   [x] Plex
+-   [x] Overseerr
+-   [x] Mdblist
+-   [x] Plex Watchlist RSS
+-   [x] Torrentio
+-   [x] Orionoid
+-   [x] Jackett
+-   [x] Listrr
+-   [ ] and more to come!
 
 Check out out [Project Board](https://github.com/users/dreulavelle/projects/2) to stay informed!
 
@@ -24,12 +40,13 @@ We are constantly adding features and improvements as we go along and squashing
 ---
 
 ## Table of Contents
-- [Docker Compose](#docker-compose)
-  - [What is ORIGIN ?](#what-is-origin-)
-- [Running outside of Docker](#running-outside-of-docker)
-- [Symlinking settings](#symlinking-settings)
-- [Development](#development)
-  - [Development without `make`](#development-without-make)
+
+-   [Docker Compose](#docker-compose)
+    -   [What is ORIGIN ?](#what-is-origin-)
+-   [Running outside of Docker](#running-outside-of-docker)
+-   [Symlinking settings](#symlinking-settings)
+-   [Development](#development)
+    -   [Development without `make`](#development-without-make)
 
 ---
 
@@ -38,26 +55,27 @@ We are constantly adding features and improvements as we go along and squashing
 Create a `docker-compose.yml` file with the following contents:
 
 ```yml
-version: '3.8'
+version: "3.8"
 
 services:
-  iceberg:
-    image: spoked/iceberg:latest
-    container_name: Iceberg
-    restart: unless-stopped
-    environment:
-      PUID: "1000"
-      PGID: "1000"
-      ORIGIN: "http://localhost:3000" # read below for more info
-    ports:
-      - "3000:3000"
-    volumes:
-      - ./data:/iceberg/data
+    iceberg:
+        image: spoked/iceberg:latest
+        container_name: Iceberg
+        restart: unless-stopped
+        environment:
+            PUID: "1000"
+            PGID: "1000"
+            ORIGIN: "http://localhost:3000" # read below for more info
+        ports:
+            - "3000:3000"
+        volumes:
+            - ./data:/iceberg/data
 ```
 
 Then run `docker compose up -d` to start the container in the background. You can then access the web interface at `http://localhost:3000` or whatever port and origin you set in the `docker-compose.yml` file.
 
 #### What is ORIGIN ?
+
 `ORIGIN` is the URL of the frontend on which you will access it from anywhere. If you are hosting Iceberg on a vps with IP address `134.32.24.44` then you will need to set the `ORIGIN` to `http://134.32.24.44:3000` (no trailing slash). Similarly, if using a domain name, you will need to set the `ORIGIN` to `http://iceberg.mydomain.com:3000` (no trailing slash). If you change the port in the `docker-compose.yml` file, you will need to change it in the `ORIGIN` as well.
 
 ## Running outside of Docker
@@ -78,6 +96,7 @@ npm install
 npm run build
 ORIGIN=http://localhost:3000 node build
 ```
+
 Read above for more info on `ORIGIN`.
 
 #### Second terminal:
@@ -90,11 +109,13 @@ python backend/main.py
 ---
 
 ## Symlinking settings
+
 "host_mount" should point to your rclone mount that has your torrents on your host, if you are using native webdav set webdav-url to "https://dav.real-debrid.com/torrents"
 
 "container_mount" should point to the location of the mount in plex container
 
 ### Example:
+
 Rclone is mounted to /iceberg/vfs on your host machine -> settings should have: "host_mount": "/iceberg/vfs"
 
 Plex container volume configuration for rclone mount is "/iceberg/vfs:/media/vfs" -> settings should have: "container_mount": "/media/vfs"
@@ -104,23 +125,25 @@ Plex libraries you want to add to sections: movies -> /media/library/movies, sho
 ---
 
 ## Development
+
 You can view the readme in `make` to get started!
 
 ```sh
 make
 ```
 
 To get started you can simply do this. This will stop any previous Iceberg containers and remove previous image.
-As well as rebuild the image using cached layers. If your a developer, then any files changed in the code will not get cached, 
+As well as rebuild the image using cached layers. If your a developer, then any files changed in the code will not get cached,
 and thus rebuilt in the image.
 
 ```sh
 make start
 ```
 
-You can also restart the container with `make restart`, or view the logs with `make logs`. 
+You can also restart the container with `make restart`, or view the logs with `make logs`.
 
 ### Development without `make`
+
 If you don't want to use `make` and docker, you can use the following commands to run development environment.
 
 ```sh
@@ -137,11 +160,17 @@ npm run dev
 ---
 
 ## Contributing
+
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 We use Black for backend and Prettier for frontend. Please make sure to run the formatters before submitting a pull request. Also use CRLF line endings unless it is a shell script or something that requires LF line endings.
 
+<a href="https://github.com/dreulavelle/iceberg/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=dreulavelle/iceberg" />
+</a>
+
 ---
 
 ## License
+
 This project is licensed under the GNU GPLv3 License - see the [LICENSE](LICENSE) file for details