From: Debayan Sutradhar <debayansutradhar3@gmail.com>
Date: Thu, 25 Feb 2021 18:52:29 +0530
Subject: Merge pull request #5 from j4ckofalltrades/add-readme-local-dev
---
Merge pull request #5 from j4ckofalltrades/add-readme-local-dev

Add README
---


--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Stream-Pi Essential Actions
+
+Set of pre-built actions and integrations for the Stream-Pi using the [Stream-Pi Action API](https://github.com/stream-pi/actionapi).
+
+## Prerequisites
+
+- Java >= 11
+- Maven >= 3.6.3
+
+## List of Actions
+
+- Hotkey
+- Website
+- Twitter
+- OBS Actions
+- Run Command
+- Text Block
+- Media File
+- Media Key
+
+## Quick Start
+
+Build actions by executing `./build.sh` from the command line.
+
+To test these actions out in your local environment you'll need to run the [Stream-Pi Server](https://github.com/stream-pi/server) and copy the contents of `PreBuiltPlugins/` to the server's
+Plugins directory (`data/Plugins` by default), especially if you're writing your own custom action / integration.