Add build instruction warning in documentation.

Instead of using dangerous command in package.json, add a comment in the documentation.
faxm0dem · Nov 18, 2020 · 18dfe40 · 18dfe40
1 parent d32ac75
commit 18dfe40
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -12,11 +12,13 @@ This datasource connects to a riemann server using websockets and subscribes to
 
 ## Getting started
 
+For instructions on how to install a riemann server, refer to its [web site](https://riemann.io).
+For building this plugin, there currently is a bug in the toolchain that prevents the correct execution. You need to run `rm -rf node_modules/@grafana/data/node_modules` in order for it to work. See the [github issue](https://github.com/grafana/grafana/issues/28395#issuecomment-714715586) for more information on that subject.
+
 0. Have a riemann instance ready with websockets enabled
 ```clojure
 (ws-server)
 ```
-
 1. Install dependencies
 ```BASH
 yarn install

diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "scripts": {
     "build": "grafana-toolkit plugin:build",
     "test": "grafana-toolkit plugin:test",
-    "dev": "rm -rf node_modules/@grafana/data/node_modules; grafana-toolkit plugin:dev",
+    "dev": "grafana-toolkit plugin:dev",
     "watch": "grafana-toolkit plugin:dev --watch"
   },
   "author": "Fᴀʙɪᴇɴ Wᴇʀɴʟɪ",