From: Jordan Duabe <1442368+j4ckofalltrades@users.noreply.github.com> Date: Mon, 22 Feb 2021 19:04:29 +0530 Subject: Add README --- Add README --- --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Stream-Pi Server + +![version](https://img.shields.io/badge/Version-1.0.0-green) + +## Prerequisites + +- Java >= 11 +- Maven >= 3.6.3 + +## Quick Start + +This project depends on the following Stream-Pi modules: + +- [Stream-Pi Action API](https://github.com/stream-pi/actionapi) +- [Stream-Pi Theme API](https://github.com/stream-pi/themeapi) +- [Stream-Pi Utilities](https://github.com/stream-pi/util) + +Build locally by executing `mvn clean install` and start the app by running `com.stream_pi.server.Main`.