markdown lint

README.md

@@ -1,4 +1,5 @@
 # Grafana Kiosk
+
 [![CircleCI](https://circleci.com/gh/grafana/grafana-kiosk.svg?style=svg)](https://circleci.com/gh/grafana/grafana-kiosk)
 [![Go Report Card](https://goreportcard.com/badge/github.com/grafana/grafana-kiosk)](https://goreportcard.com/report/github.com/grafana/grafana-kiosk) [![codecov](https://codecov.io/gh/grafana/grafana-kiosk/branch/master/graph/badge.svg)](https://codecov.io/gh/grafana/grafana-kiosk)
 
@@ -10,7 +11,7 @@ The utitilty provides these options:
 
 - login
   - to a Grafana server (local account)
-  - to a grafana server with anonymous-mode enabled (same method used on https://play.grafana.org)
+  - to a grafana server with anonymous-mode enabled (same method used on [play.grafana.org](https://play.grafana.org))
   - to a hosted grafana instance
 - switch to kiosk or kiosk-tv mode
 - display the default home page set for the user
@@ -23,45 +24,51 @@ Additionally, an initialize option is provided to configure LXDE for Raspberry P
 
 Download the zip or tar file from [releases](https://github.com/grafana/grafana-kiosk/releases)
 
-The release file includes pre-built binaries for the following:
+The release file includes pre-built binaries. See table below for the types available.
+
 |  OS    | Architecture | Description    | Executable                      |
-|--------|--------------|----------------|---------------------------------|
+| ------ | ------------ | -------------- | ------------------------------- |
 | linux  | amd64        | 64bit          | grafana-kiosk.linux.amd64       |
 | linux  | 386          | 32bit          | grafana-kiosk.linux.386         |
 | linux  | arm64        | 64bit Arm v7   | grafana-kiosk.linux.arm64       |
 | linux  | arm          | ARM v5         | grafana-kiosk.linux.armv5       |
 | linux  | arm          | ARM v6         | grafana-kiosk.linux.armv6       |
 | linux  | arm          | ARM v7         | grafana-kiosk.linux.armv7       |
-| * darwin | amd64        | 64bit          | grafana-kiosk.darwin.amd64     |
-| * windows| amd64        | 64bit          | grafana-kiosk.windows.amd64.exe|
+| darwin | amd64        | 64bit          | grafana-kiosk.darwin.amd64      |
+| windows| amd64        | 64bit          | grafana-kiosk.windows.amd64.exe |
 
-* NOTE darwin and windows builds are still under development
+- NOTE darwin and windows builds are still under development
 
 ## Usage
 
 `--URL`
-  - URL to a Grafana server
+
+- URL to a Grafana server
 
 `--playlist`
-  - designates the URL as a playlist, allowing instant "inactive" user vs waiting for the timeout
+
+- designates the URL as a playlist, allowing instant "inactive" user vs waiting for the timeout
 
 `--login-method` (default anon)
-  - anon (anonymous)
-  - local (local user)
-  - gcom (Hosted Grafana)
+
+- anon (anonymous)
+- local (local user)
+- gcom (Hosted Grafana)
 
 `--username` used with local and gcom login methods
 
 `--password` used with local and gcom login methods
 
 `--kiosk-mode`
-  - full  (no sidebar, top navigation disabled)
-  - tv (no sidebar, top navigation enabled)
-  - disabled (sidebar and top navigation enabled)
+
+- full  (no sidebar, top navigation disabled)
+- tv (no sidebar, top navigation enabled)
+- disabled (sidebar and top navigation enabled)
 
 `--autofit` scales panels to fit the display (default is true)
-  - true
-  - false 
+
+- true
+- false
 
 `--lxde` enables initialization of LXDE
 
@@ -107,7 +114,6 @@ This will take the browser to the default dashboard on play.grafana.org in fulls
 ./bin/grafana-kiosk --URL https://play.grafana.org --login-method anon --kiosk-mode tv
 ```
 
-
 This will take the browser to a playlist on play.grafana.org in fullscreen kiosk mode (no login needed):
 
 ```bash
@@ -125,9 +131,10 @@ make
 This will generate executables in "bin" that can be run on a variety of platforms.
 
 ## TODO
+
 - Support for OAuth2 logins
 
 ## References
 
-- https://grafana.com/docs/guides/whats-new-in-v5-3/#tv-and-kiosk-mode
-- https://grafana.com/docs/reference/playlist/
+- [TV and Kiosk Mode](https://grafana.com/docs/guides/whats-new-in-v5-3/#tv-and-kiosk-mode)
+- [Grafana Playlists](https://grafana.com/docs/reference/playlist)