aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 27 insertions, 26 deletions
diff --git a/README.md b/README.md
index 9441798..e13b2f0 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,46 @@
1<h1 align="center"> 1<h1 align="center">
2 <img 2 <img
3 width="180" 3 width="180"
4 alt="Homer's donut" 4 alt="Homer's donut"
5 src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png"> 5 src="https://raw.githubusercontent.com//bastienwirtz/homer/main/public/logo.png">
6 <br/> 6 <br/>
7 Homer 7 Homer
8</h1> 8</h1>
9 9
10<h4 align="center"> 10<h4 align="center">
11 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. 11 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.
12</h4> 12</h4>
13 13
14<p align="center"> 14<p align="center">
15 <strong> 15 <strong>
16 <a href="https://homer-demo.netlify.app">Demo</a> 16 <a href="https://homer-demo.netlify.app">Demo</a>
17 17
18 <a href="https://gitter.im/homer-dashboard/community">Chat</a> 18 <a href="https://gitter.im/homer-dashboard/community">Chat</a>
19 19
20 <a href="#getting-started">Getting started</a> 20 <a href="#getting-started">Getting started</a>
21 </strong> 21 </strong>
22</p> 22</p>
23<p align="center"> 23<p align="center">
24 <a href="https://opensource.org/licenses/Apache-2.0"><img 24 <a href="https://opensource.org/licenses/Apache-2.0"><img
25 alt="License: Apache 2" 25 alt="License: Apache 2"
26 src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> 26 src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
27 <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img 27 <a href="https://gitter.im/homer-dashboard/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img
28 alt="Gitter chat" 28 alt="Gitter chat"
29 src="https://badges.gitter.im/homer-dashboard/community.svg"></a> 29 src="https://badges.gitter.im/homer-dashboard/community.svg"></a>
30 <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img 30 <a href="https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip"><img
31 alt="Download homer static build" 31 alt="Download homer static build"
32 src="https://img.shields.io/badge/Download-homer.zip-orange"></a> 32 src="https://img.shields.io/badge/Download-homer.zip-orange"></a>
33 <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img 33 <a href="https://github.com/awesome-selfhosted/awesome-selfhosted"><img
34 alt="Awesome" 34 alt="Awesome"
35 src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a> 35 src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
36</p> 36</p>
37 37
38<p align="center"> 38<p align="center">
39 <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%"> 39 <img src="https://raw.github.com/bastienwirtz/homer/main/docs/screenshot.png" width="100%">
40</p> 40</p>
41 41
42## Table of Contents 42## Table of Contents
43
43- [Features](#features) 44- [Features](#features)
44- [Getting started](#getting-started) 45- [Getting started](#getting-started)
45- [Configuration](docs/configuration.md) 46- [Configuration](docs/configuration.md)
@@ -49,19 +50,19 @@
49 50
50 51
51## Features 52## Features
53
52- [yaml](http://yaml.org/) file configuration 54- [yaml](http://yaml.org/) file configuration
53- Installable (pwa) 55- Installable (pwa)
54- Search 56- Search
55- Grouping 57- Grouping
56- Theme customization 58- Theme customization
57- Offline heathcheck 59- Offline heath check
58- keyboard shortcuts: 60- keyboard shortcuts:
59 - `/` Start searching. 61 - `/` Start searching.
60 - `Escape` Stop searching. 62 - `Escape` Stop searching.
61 - `Enter` Open the first matching result (respects the bookmark's `_target` property). 63 - `Enter` Open the first matching result (respects the bookmark's `_target` property).
62 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab. 64 - `Alt`/`Option` + `Enter` Open the first matching result in a new tab.
63 65
64
65## Getting started 66## Getting started
66 67
67Homer 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**. 68Homer 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:
111 112
112### Using the release tarball (prebuilt, ready to use) 113### Using the release tarball (prebuilt, ready to use)
113 114
114Download 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. 115Download 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.
115 116
116```sh 117```sh
117wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip 118wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip