diff --git a/README.md b/README.md index b121bc2..cf2789f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,27 @@ -# CraftBeerPi +# CraftBeerPi 4 -You will finde the documentation here: https://craftbeerpi.gitbook.io/craftbeerpi4/ +[![Build](https://github.com/avollkopf/craftbeerpi4/actions/workflows/build.yml/badge.svg)](https://github.com/avollkopf/craftbeerpi4/actions/workflows/build.yml) +[![GitHub license](https://img.shields.io/github/license/avollkopf/craftbeerpi4)](https://github.com/avollkopf/craftbeerpi4/blob/master/LICENSE) +![GitHub issues](https://img.shields.io/github/issues-raw/Manuel83/craftbeerpi4) +![PyPI](https://img.shields.io/pypi/v/cbpi) +![Happy Brewing](https://img.shields.io/badge/CraftBeerPi%204-Happy%20Brewing-%23FBB117) +
+ +
+ +CraftBeerPi 4 is an open source software solution to control the brewing and +fermentation of beer :beer:. + +## 📚 Documentation +Instructions on how to install CraftBeerPi and use its plugins is described +in the documentation, that can be found here: [gitbook.io](https://openbrewing.gitbook.io/craftbeerpi4_support/). + +### Plugins +Plugins extend the base functionality of CraftBeerPi 4. +You can find a list of available plugins [here](https://openbrewing.gitbook.io/craftbeerpi4_support/master/plugin-installation#plugin-list). + +## 🧑🤝🧑 Contributers +Thanks to all the people who have contributed + +[![contributors](https://contributors-img.web.app/image?repo=avollkopf/craftbeerpi4)](https://github.com/avollkopf/craftbeerpi4/graphs/contributors)