From 5e00906d6823aa0e96e939e3ae255a63aa421cc0 Mon Sep 17 00:00:00 2001
From: Pascal Precht <pascal.precht@googlemail.com>
Date: Thu, 6 Feb 2020 12:41:01 +0100
Subject: [PATCH] Add API docs for scripts-runner

---
 API-Documentation.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/API-Documentation.md b/API-Documentation.md
index ab55d4b..3bdb37c 100644
--- a/API-Documentation.md
+++ b/API-Documentation.md
@@ -47,6 +47,7 @@
 * profiler
 * rpc-manager
 * scaffolding
+* [scripts-runner](#scripts-runner)
 * snark
 * solc
 * solidity-tests
@@ -523,6 +524,18 @@ module type: plugin component
 * `deployment:deployContracts:afterAll` - to associate contract addresses to ens domain
 * `deployment:contract:beforeDeploy` - to replace contract arguments if they have ens domains with the associated adddress
 
+### scripts-runner
+
+Plugins to execute (migration) scripts inside Embark projects.
+
+#### Requests
+
+**name**: `scripts-runner:execute`
+**description**: Takes a path to a file or directory and tries to run the script(s) that the path is pointing to. If a path to a directory is given, all files inside of that directory are considered script files.
+**params**:
+* `target: string` - Path to script file or directory containing scripts.
+* `forceTacking: boolean` - Flag to enforce tracking of scripts to be executed. By default, scripts-runner only track scripts that live inside a configured migrations directory.
+
 ### graph
 
 module type: plugin