Bump browserslist from 4.16.4 to 4.16.6

[github/bastienwirtz/homer.git] / README.md

diff --git a/README.md b/README.md
index 33a15b19f1af8a23c98719b4bf03f38456fab254..945fa1f7192393e737126a5c534c6d44aa366f76 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,13 +2,13 @@
        <img
                width="180"
                alt="Homer's donut"
-               src="https://raw.githubusercontent.com//bastienwirtz/homer/master/public/logo.png">
+               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 `yaml` 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">
@@ -36,7 +36,7 @@
 </p>
 
 <p align="center">
-       <img src="https://raw.github.com/bastienwirtz/homer/master/docs/screenshot.png" width="100%">
+       <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
 </p>
 
 ## Table of Contents
@@ -44,15 +44,15 @@
 - [Getting started](#getting-started)
 - [Configuration](docs/configuration.md)
 - [Tips & tricks](docs/tips-and-tricks.md)
-- [Roadmap](#roadmap) 
-- [Developement](docs/developement.md)
+- [Roadmap](#roadmap)
+- [Development](docs/development.md)
 
 
 ## Features
 - [yaml](http://yaml.org/) file configuration
 - Installable (pwa)
 - Search
-- Grouping 
+- Grouping
 - Theme customization
 - Offline heathcheck
 - keyboard shortcuts:
@@ -70,16 +70,49 @@ See [documentation](docs/configuration.md) for information about the configurati
 
 ### Using docker
 
+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" [...]`).
 
+### Using docker-compose
+
+The `docker-compose.yml` file must be edited to match your needs.
+Set the port and volume (equivalent to `-p` and `-v` arguments):
+
+```yaml
+volumes:
+  - /your/local/assets/:/www/assets
+ports:
+  - 8080:8080
+```
+
+To launch container:
+
+```sh
+cd /path/to/docker-compose.yml
+docker-compose up -d
+```
+
+Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml`:
+
+```yaml
+environment:
+  - UID=1000
+  - GID=1000
+```
+
 ### Using the release tarball (prebuilt, ready to use)
 
-Download and extract the latest 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 webserver.
+
 ```sh
 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 unzip homer.zip