Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
joseananio committed Jan 7, 2019
1 parent 99ad973 commit ae6210c
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<br/>

## 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

Expand All @@ -109,7 +110,7 @@ or
```
yarn add codic
```

<br/>

## Usage

Expand Down Expand Up @@ -174,6 +175,7 @@ var codic = new Codic(driver);
// ... continue as above
```
<br/>

## Concept

[Codic](https://github.com/joseananio/codic.git) uses Activities and Tasks to let you automate processes in your app.
Expand Down Expand Up @@ -245,6 +247,7 @@ await codic.run(

```
<br/>

## 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.
Expand Down Expand Up @@ -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.

<br/>

## Creating drivers

Creating a codic storage driver is easy. Just implement the methods and properties on the driver interface and you are done.
Expand Down

0 comments on commit ae6210c

Please sign in to comment.