|
1 | 1 | ## Software to create a Raspberry Pi based wordclock
|
2 | 2 |
|
| 3 | +### :vertical_traffic_light: Repo status |
| 4 | + |
| 5 | +<p align="left"> |
| 6 | + <img alt="Source code license" src="https://img.shields.io/github/license/bk1285/rpi_wordclock"/> |
| 7 | + <img alt="GitHub Issue Count" src="https://img.shields.io/github/issues/bk1285/rpi_wordclock"/> |
| 8 | + <img alt="GitHub (Pre-)Release Date" src="https://img.shields.io/github/release-date-pre/bk1285/rpi_wordclock"> |
| 9 | + <img alt="Build status documentation" src="https://readthedocs.org/projects/rpi-wordclock/badge/"/> |
| 10 | +</p> |
| 11 | + |
3 | 12 | ### ✔️ Features
|
4 |
| - * [Various language layouts](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_layouts) |
5 |
| - * [Various plugins](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_plugins) to |
6 |
| - * display the current time |
7 |
| - * get information on current temperature, sunrise, sunset, IP-settings, ... |
8 |
| - * play tetris (credits to [@mrksngl](https://github.com/mrksngl)) |
9 |
| - * View a demo [here](https://youtu.be/wcLQDykRBbM?t=84) |
10 |
| - * RESTful, [swagger](https://swagger.io/specification/)-based API to access and control the wordclock functionality |
11 |
| - * [Documentation](http://rpi-wordclock.readthedocs.io/en/master/) on how to build the clock. |
12 |
| - * Remote control via webinterface (credits to [@FrankX0](https://github.com/FrankX0)) |
13 |
| - * Control the wordclock with a browser within your local network |
14 |
| - * Linking the webinterface to your smartphones homescreen provides an app-like usage of the interface |
15 |
| - * Hardware buttons are not mandatory anymore. |
16 |
| - * Integration to your instance of [home-assistant](https://www.home-assistant.io/) using [this repository](https://github.com/bk1285/rpi_wordclock_for_homeassistant/) |
| 13 | + * [Various language layouts](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_layouts) |
| 14 | + * [Various plugins](https://github.com/bk1285/rpi_wordclock/tree/master/wordclock_plugins) to |
| 15 | + * display the current time |
| 16 | + * get information on current temperature, sunrise, sunset, IP-settings, ... |
| 17 | + * play tetris (credits to [@mrksngl](https://github.com/mrksngl)) |
| 18 | + * View a demo [here](https://youtu.be/wcLQDykRBbM?t=84) |
| 19 | + * RESTful, [swagger](https://swagger.io/specification/)-based API to access and control the wordclock functionality |
| 20 | + * [Documentation](http://rpi-wordclock.readthedocs.io/en/master/) on how to build the clock. |
| 21 | + * Remote control via webinterface (credits to [@FrankX0](https://github.com/FrankX0)) |
| 22 | + * Control the wordclock with a browser within your local network |
| 23 | + * Linking the webinterface to your smartphones homescreen provides an app-like usage of the interface |
| 24 | + * Hardware buttons are not mandatory anymore. |
| 25 | + * Integration to your instance of [home-assistant](https://www.home-assistant.io/) using [this repository](https://github.com/bk1285/rpi_wordclock_for_homeassistant/) |
17 | 26 |
|
18 | 27 | ### ⏳ In progress
|
19 |
| - * Integration of a brightness sensor |
| 28 | + * Integration of a brightness sensor |
20 | 29 |
|
21 | 30 | ### :books: Further reading
|
22 |
| - * Exemplary builds are available at [pinterest](https://www.pinterest.de/berndkrolla/wordclock-gallery/) |
23 |
| - * [Roadmap](https://github.com/bk1285/rpi_wordclock/projects) |
| 31 | + * Exemplary builds are available at [pinterest](https://www.pinterest.de/berndkrolla/wordclock-gallery/) |
| 32 | + * [Roadmap](https://github.com/bk1285/rpi_wordclock/projects) |
24 | 33 |
|
25 | 34 | ### 👏 Support
|
26 |
| - * :star2: Star this repo, if you like the project. |
27 |
| - * Request a new feature by [opening a issue](https://github.com/bk1285/rpi_wordclock/issues), describing your feature request. |
28 |
| - * Contribute your code: [Learn how to create your own plugin](https://rpi-wordclock.readthedocs.io/en/master/doc_further_reading.html#adding-a-new-plugin) |
| 35 | + * :star2: Star this repo, if you like the project. |
| 36 | + * Request a new feature by [opening a issue](https://github.com/bk1285/rpi_wordclock/issues), describing your feature request. |
| 37 | + * Contribute your code: [Learn how to create your own plugin](https://rpi-wordclock.readthedocs.io/en/master/doc_further_reading.html#adding-a-new-plugin) |
0 commit comments