diff --git a/README.md b/README.md index 6793c9d..66ba0b6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ -# CraftBeerPi4 +# CraftBeerPi -This is the development project for CraftBeerPi4. -It's not ready to use at the moment. +## Intro + +CraftBeerPi is an open source brewing controller. + +## Installation + +CraftBeerPi is python based and will require at last python 3.7.x + +```text +sudo python3 -m pip install cbpi +``` + +```text +cbpi setup +``` + +```text +cbpi start +``` + +## Links + +{% embed url="https://www.facebook.com/groups/craftbeerpi" %} + +{% embed url="https://www.youtube.com/channel/UCy47sYaG8YLwJWw2iY5\_aNg" %} + +{% embed url="http://web.craftbeerpi.com" %} -[See Documentation](https://manuel83.github.io/craftbeerpi4/) \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..245c4d7 --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,4 @@ +# Table of contents + +* [CraftBeerPi](README.md) +