#1 Update README, CONTRIBUTING & docs

Author: njoubert-cleverage

CONTRIBUTING.md

@@ -44,8 +44,8 @@ make tests
 
 When a feature should be deprecated, or when you have a breaking change for a future version, please :
 * [Fill an issue](https://github.com/cleverage/process-bundle-demo/issues/new)
-* Add TODO comments with the following format: `@TODO deprecated v2.0`
-* Trigger a deprecation error: `@trigger_error('This feature will be deprecated in v4.0', E_USER_DEPRECATED);`
+* Add TODO comments with the following format: `@TODO deprecated v1.0`
+* Trigger a deprecation error: `@trigger_error('This feature will be deprecated in v1.0', E_USER_DEPRECATED);`
 
 You can check which deprecation notice is triggered in tests
 * `make bash`

README.md

@@ -3,15 +3,10 @@ CleverAge/ProcessBundleDemo
 
 A demo project using cleverage/process-bundle & cleverage/*-process-bundle bridges
 
-## Usage
+## Documentation
 
-```shell script
-make start
-```
-
-Then access to UI via http://process-bundle-demo.localhost/process (username: [email protected] / password: [email protected])
-
-By default, this demo use sqlite as default database. Feel free to user pgsql or mysql/mariadb in you project.
+For usage documentation, see:
+[docs/index.md](docs/index.md)
 
 ## Support & Contribution
 

docs/index.md

@@ -0,0 +1,12 @@
+## Usage
+
+```bash
+make start
+```
+
+Then access to UI via http://process-bundle-demo.localhost/process (username: [email protected] / password: [email protected])
+
+By default, this demo use sqlite as default database. Feel free to user pgsql or mysql/mariadb in you project.
+
+## Reference
+

docs/reference/tasks/_template.md

@@ -0,0 +1,44 @@
+TaskName
+========
+
+_Describe main goal an use cases of the task_
+
+Task reference
+--------------
+
+* **Service**: `ClassName`
+
+Accepted inputs
+---------------
+
+_Description of allowed types_
+
+Possible outputs
+----------------
+
+_Description of possible types_
+
+Options
+-------
+
+| Code | Type | Required | Default | Description |
+| ---- | ---- | :------: | ------- | ----------- |
+| `code` | `type` | **X** _or nothing_ | `default value` _if available_ | _description_ |
+
+Examples
+--------
+
+_YAML samples and explanations_ 
+
+* Example 1
+  - details
+  - details
+  
+```yaml
+# Task configuration level
+code:
+    service: '@service_ref'
+    options: 
+        a: 1
+        b: 2
+```