From ae6210cbee36a3fa1bee4744273979ddeff29a88 Mon Sep 17 00:00:00 2001 From: joseananio Date: Mon, 7 Jan 2019 02:23:04 +0000 Subject: [PATCH] doc --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2a83786..a3aa7d2 100644 --- a/README.md +++ b/README.md @@ -88,17 +88,18 @@ Kudos for making the comparison chart goes to [Bull](https://www.npmjs.com/packa The inspiration comes from [Agenda](https://github.com/agenda/agenda) +
## Content -[Installation](#installation) -[Usage](#usage) -[Concept](#concept) -[More Examples](#more-examples) -[Dynamic Tasks](#dynamic-tasks) -[Updating activities](#updating-activities) -[Codic v2 Typescript](#codic-v2-typescript) -[Creating Drivers](#creating-drivers) +- [Installation](#installation) +- [Usage](#usage) +- [Concept](#concept) +- [More Examples](#more-examples) +- [Dynamic Tasks](#dynamic-tasks) +- [Updating activities](#updating-activities) +- [Codic v2 Typescript](#codic-v2-typescript) +- [Creating Drivers](#creating-drivers) ## Installation @@ -109,7 +110,7 @@ or ``` yarn add codic ``` - +
## Usage @@ -174,6 +175,7 @@ var codic = new Codic(driver); // ... continue as above ```
+ ## Concept [Codic](https://github.com/joseananio/codic.git) uses Activities and Tasks to let you automate processes in your app. @@ -245,6 +247,7 @@ await codic.run( ```
+ ## Dynamic tasks Dynamic tasks can be created and executed at any point in your execution cycle. You will then be able to pass different data to the task at any point in your code. @@ -326,6 +329,7 @@ Right on the start, you get a default memory driver. That means codic can work s For production use, do opt for an external persistent storage driver.
+ ## Creating drivers Creating a codic storage driver is easy. Just implement the methods and properties on the driver interface and you are done.