X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=5ea80fb84575b865f964fe2fa69be5fe58c8fd98;hb=a1a70d4a3c6a8314dd2ad35344d440e4ba8e86e8;hp=944179877705d1d6f026eb02fad74385e9c5f416;hpb=a6b7db5437b04ef7acfcb5f269e88b2451aaa396;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/README.md b/README.md index 9441798..5ea80fb 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,68 @@

- Homer's donut + Homer's donut
Homer

- A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. + A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file.

- - Demo - • - Chat - • - Getting started - + + Demo + • + Chat + • + Getting started +

- License: Apache 2 + License: Apache 2 Gitter chat + alt="Gitter chat" + src="https://badges.gitter.im/homer-dashboard/community.svg"> Download homer static build - Awesome + alt="Download homer static build" + src="https://img.shields.io/badge/Download-homer.zip-orange"> + Awesome

- +

## 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) - [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**. @@ -111,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