Added README draft

2020-06-21 18:30:24 +02:00 · 2020-06-21 18:30:24 +02:00 · 3b8fe4e4f8
parent 83b4a30705
commit 3b8fe4e4f8
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,18 @@
+# Platypush browser extension
+
+This extension allows you to run Platypush commands on remote hosts as well as
+custom scripts, and attach hooks to events generated by remote Platypush systems.
+
+## Installation
+
+Default installation (requires npm):
+
+```bash
+npm run build
+```
+
+Dev installation (requires npm+Vue cli tools):
+
+```bash
+npm run build:dev
+```