1.0.0

Author: elbywan

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Snips
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,9 +1,44 @@
 # snips-actions-runner
+### A lightweight javascript actions runner.
 
-**Setup:**
+## Purpose
+
+The standard way to run Snips actions is to use the [`snips-skill-server`](https://docs.snips.ai/articles/console/actions/actions/code-your-action/action-specifications#specifications) binary that comes pre-installed with the Snips distribution.
+
+The way the `skill-server` works is that it runs one process per-action.
+
+It means that a `node.js` instance is spawned and bindings to the hermes library are created for each action.
+
+**This is perfectly fine is mosts cases**, but when the number of actions to run is huge or if the environment is memory constrained this can become a problem.
+
+This package is an attempt to mitigate memory issues by running every javascript action using a single process.
+
+## Setup
 
 `npm i -g snips-actions-runner`
 
-**Usage:**
+*It is recommended to create a daemon to launch the runner automatically, but this is beyond the scope of this file.*
+
+## Specifications
+
+### Root folder
+
+By default, the runner will look for actions in the `/var/lib/snips/skills` folder on linux, or `/var/lib/snips/skills` for macos.
+
+For other oses, use the `-r` option to specify the root folder.
+
+### Action
+
+Each subfolder will then be scanned, and will be considered as an action **if and only if**:
+
+1) It contains a `package.json` file.
+2) The `package.json` file has a `dependency` field that contains the [`snips-toolkit`](https://github.com/snipsco/snips-javascript-toolkit) package.
+3) The `package.json` file has a `main` field.
+
+The file linked with the `main` field is then launched using a global `snips-toolkit` package ([in the same fashion as the run command](https://github.com/snipsco/snips-javascript-toolkit#snips-toolkit-run)).
+
+## Usage
+
+`snips-runner --help`
+
 
-`snips-runner --help`

package.json

@@ -1,8 +1,8 @@
 {
   "name": "snips-actions-runner",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "Snips javascript actions runner.",
-  "main": "src/index.js",
+  "main": "cli.js",
   "bin": {
     "snips-runner": "./cli.js"
   },
@@ -11,7 +11,7 @@
   "dependencies": {
     "chalk": "^2.4.2",
     "commander": "^2.20.0",
-    "snips-toolkit": "^0.1.1"
+    "snips-toolkit": "1.0.1"
   },
   "devDependencies": {
     "eslint": "^5.16.0"