Add setup instructions to readme (#1)

artilleryio · Mar 6, 2019 · 343c1de · 343c1de
1 parent 4b86fae
commit 343c1de
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/packages/artillery-plugin-metrics-by-endpoint/README.md b/packages/artillery-plugin-metrics-by-endpoint/README.md
@@ -3,6 +3,26 @@
 
 Use this plugin to get a per-endpoint breakdown of latency and response codes in your Artillery HTTP tests.
 
+# Usage
+
+Install the plugin globally or locally, depending on your setup
+
+```
+// global plugin installation
+ npm install artillery-plugin-metrics-by-endpoint -g
+ 
+ // local plugin installation
+ npm install --save-dev artillery-plugin-metrics-by-endpoint
+```
+
+Enable the plugin in the config
+
+```
+config:
+  plugins:
+    metrics-by-endpoint: {}
+```
+
 # License
 
 MPL 2.0