Typo

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

diff --git a/README.md b/README.md
index 1abce2f212a6298811f881d3b4c0a1bd33e1c88b..aa934f73278b3ac693ea8b157ff5e0ee60e39e4a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@ If you need authentication support, you're on your own (it can be secured using
 ### Using docker
 
 ```sh
-sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
 ```
 
 ### Manually
@@ -47,9 +47,11 @@ npm run build
 ```
 
 Then your dashboard is ready to use in the `/dist` directory.
+The `dist` directory is meant to be served by an HTTP server, so **it will not work if you open dist/index.html directly over file:// protocol**.
+
 Use it like any static HTML content (use a webserver or open the html index directly).
 
-## Developement
+## Development
 
 ```sh
 # Using yarn (recommended)
@@ -61,9 +63,9 @@ npm install
 npm run serve
 ```
 
-### themes
+### Themes
 
-Theme are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
+Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
 To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
 
 ```scss
@@ -81,7 +83,7 @@ body #app.theme-my-awesome-theme. { ... }
 
 ## Configuration
 
-Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
+Title, icons, links, colors, and services can be configured in the `config.yml` file (located in project root directory once built, or in the `public/` directory in developement mode), using [yaml](http://yaml.org/) format.
 
 ```yaml
 ---
@@ -142,7 +144,7 @@ links:
   - name: "ansible"
     icon: "fab fa-github"
     url: "https://github.com/xxxxx/ansible/"
-    target: "_blank" # optional html a tag target attribute
+    target: "_blank" # optional html tag target attribute
   - name: "Wiki"
     icon: "fas fa-book"
     url: "https://wiki.xxxxxx.com/"
@@ -161,7 +163,7 @@ services:
         subtitle: "Continuous integration server"
         tag: "CI"
         url: "#"
-        target: "_blank" # optional html a tag target attribute
+        target: "_blank" # optional html tag target attribute
       - name: "RabbitMQ Management"
         logo: "/assets/tools/rabbitmq.png"
         subtitle: "Manage & monitor RabbitMQ server"