diff --git a/README.md b/README.md new file mode 100644 index 0000000..c87718b --- /dev/null +++ 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 +```