Added install instructions to readme and added bin to composer conf

Xantios · Jan 19, 2021 · 476a134 · 476a134
1 parent 7f06b8a
commit 476a134
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/composer.json b/composer.json
@@ -8,6 +8,7 @@
             "email": "git@xantios.nl"
         }
     ],
+    "bin": ["bin/maple"],
     "require": {
         "react/child-process": "^0.6.1",
         "symfony/console": "^5.2",

diff --git a/readme.md b/readme.md
@@ -9,6 +9,15 @@ Maple providers the task runner you always wanted but never dared to ask for.
 ## NOTICE
 Maple is current in active development (say alpha state) production use is **NOT** yet recommend
 
+## Installation 
+**Notice!** 
+
+Currently there is no public stable release: please add `"minimum-stability": "dev"` to your composer.json
+
+```bash 
+composer require xantios/maple
+```
+
 ## Configuration
 
 The configuration file is a plain PHP array