X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=5ea80fb84575b865f964fe2fa69be5fe58c8fd98;hb=a1a70d4a3c6a8314dd2ad35344d440e4ba8e86e8;hp=33716f63607fcc9fa76aac5bb59f24ce34d70a87;hpb=2bd57d17fd5af26fd014b653ac97e58d2fc3c52b;p=github%2Fbastienwirtz%2Fhomer.git

diff --git a/README.md b/README.md
index 33716f6..5ea80fb 100644
--- a/README.md
+++ b/README.md
@@ -1,67 +1,68 @@
 <h1 align="center">
-	<img
-		width="180"
-		alt="Homer's donut"
-		src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
+ <img
+  width="180"
+  alt="Homer's donut"
+  src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
     <br/>
     Homer
 </h1>
 
 <h4 align="center">
-	A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
+ A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file.
 </h4>
 
 <p align="center">
-	<strong>
-  	<a href="https://homer-demo.netlify.app">Demo</a>
-		•
-		<a href="https://gitter.im/homer-dashboard/community">Chat</a>
-		•
-		<a href="#getting-started">Getting started</a>
-	</strong>
+ <strong>
+   <a href="https://homer-demo.netlify.app">Demo</a>
+  •
+  <a href="https://gitter.im/homer-dashboard/community">Chat</a>
+  •
+  <a href="#getting-started">Getting started</a>
+ </strong>
 </p>
 <p align="center">
-	<a href="https://opensource.org/licenses/Apache-2.0"><img
-		alt="License: Apache 2"
-		src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+ <a href="https://opensource.org/licenses/Apache-2.0"><img
+  alt="License: Apache 2"
+  src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
   <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
-		alt="Gitter chat"
-		src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
+  alt="Gitter chat"
+  src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
   <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
-		alt="Download homer static build"
-		src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
-	<a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
-		alt="Awesome"
-		src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
+  alt="Download homer static build"
+  src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
+ <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
+  alt="Awesome"
+  src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
 </p>
 
 <p align="center">
-	<img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
+ <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
 </p>
 
 ## Table of Contents
+
 - [Features](#features)
 - [Getting started](#getting-started)
 - [Configuration](docs/configuration.md)
+- [Custom services](docs/customservices.md)
 - [Tips & tricks](docs/tips-and-tricks.md)
-- [Roadmap](#roadmap)
 - [Development](docs/development.md)
-
+- [Troubleshooting](docs/troubleshooting.md)
 
 ## Features
+
 - [yaml](http://yaml.org/) file configuration
 - Installable (pwa)
 - Search
 - Grouping
 - Theme customization
-- Offline heathcheck
+- Offline health check
 - keyboard shortcuts:
   - `/` Start searching.
   - `Escape` Stop searching.
   - `Enter` Open the first matching result (respects the bookmark's `_target` property).
   - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
 
-
 ## Getting started
 
 Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**.
@@ -73,7 +74,11 @@ See [documentation](docs/configuration.md) for information about the configurati
 To launch container:
 
 ```sh
-docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest
+docker run -d \
+  -p 8080:8080 \
+  -v </your/local/assets/>:/www/assets \
+  --restart=always \
+  b4bz/homer:latest
 ```
 
 Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`).
@@ -107,7 +112,7 @@ environment:
 
 ### Using the release tarball (prebuilt, ready to use)
 
-Download and extract the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver.
+Download and extract the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a web server.
 
 ```sh
 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
@@ -130,9 +135,3 @@ npm run build
 ```
 
 Then your dashboard is ready to use in the `/dist` directory.
-
-
-## Roadmap
-
-- [ ] Add new themes.
-- [ ] Add support for custom service card (add custom feature to some service / app link)