doc: switch to documentation

Author: arlac77

README.md

@@ -16,22 +16,78 @@
 [![downloads](http://img.shields.io/npm/dm/kronos-step.svg?style=flat-square)](https://npmjs.org/package/kronos-step)
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
+# kronos-step
 
-kronos-step
-===========
 basic step implementation
 
+# API
 
-install
-=======
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [Step](#step)
+    -   [startupOrder](#startuporder)
+    -   [endpointParentSeparator](#endpointparentseparator)
+    -   [log](#log)
+    -   [name](#name)
+    -   [startupOrder](#startuporder-1)
+-   [StepProviderMixin](#stepprovidermixin)
+
+## Step
+
+**Extends Service**
+
+Steps are building blocks for flows
+
+### startupOrder
+
+Order in which the step should be started.
+Higher numbers result in earlier startup
+
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** delivered from the constructors startupOrder
+
+### endpointParentSeparator
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** separator between step name and endpoint name
+
+### log
+
+adds 'step-type' and 'step-name'
+
+**Parameters**
+
+-   `level`  
+-   `arg`  
+
+### name
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'kronos-step'
+
+### startupOrder
+
+Order in which the step should be started.
+Higher numbers result in earlier startup
+
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 1.0
+
+## StepProviderMixin
+
+Provide steps.
+Register and lookup step types
+
+**Parameters**
+
+-   `superclass`  
+
+# install
 
 With [npm](http://npmjs.org) do:
 
 ```shell
 npm install kronos-step
 ```
 
-license
-=======
+# license
 
 BSD-2-Clause

doc/README.hbs

@@ -4,7 +4,13 @@ import { StepProviderMixin } from './step-provider-mixin';
 
 export { StepProviderMixin };
 
+/**
+ * Steps are building blocks for flows
+ */
 export class Step extends Service {
+  /**
+   * @return {string} 'kronos-step'
+   */
   static get name() {
     return 'kronos-step';
   }
@@ -28,12 +34,15 @@ export class Step extends Service {
   }
 
   /**
-   * @return {String} separator between step name and endpoint name
+   * @return {string} separator between step name and endpoint name
    **/
   get endpointParentSeparator() {
     return '/';
   }
 
+  /**
+   * adds 'step-type' and 'step-name'
+   **/
   log(level, arg) {
     this.endpoints.log.receive(
       makeLogEvent(level, arg, {