Skip to content

Commit 9a98952

Browse files
author
Vidas P
committed
Add Usage section to the README
1 parent 4e93780 commit 9a98952

File tree

2 files changed

+1035
-10
lines changed

2 files changed

+1035
-10
lines changed

README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ you to automate internal or external workflows.
1919
Overview
2020
</a>
2121
<span> • </span>
22+
<a href="#Usage">
23+
Usage
24+
</a>
25+
<span> • </span>
2226
<a href="#built-in-agents">
2327
Built-in Agents
2428
</a>
@@ -95,7 +99,29 @@ also be exported and imported, so you can share automation solutions as a unit.
9599

96100
<img src="media/workflow_diagram_screenshot.png"
97101
srcset="media/workflow_diagram_screenshot@2x.png 2x"
98-
alt="Workflow diagram">
102+
alt="ActiveWorkflow workflow diagram" />
103+
104+
## Usage
105+
106+
Once you have ActiveWorkflow up and running you will want to create some agents and most probably to arrange them in one or more workflows. You can use ActiveWorkflow via its web interface and its <a href="#rest-api">REST API</a> as illustrated in the diagram below where a1-a6 are six agents and w1-w3 are three workflows these agents participate in.
107+
108+
<img src="media/AW_usage_diagram.svg" alt="ActiveWorkflow system overview diagram" />
109+
110+
### Creating Agents
111+
112+
There are currently three ways to create agents, listed below in order of ease:
113+
114+
1. You can create a new instance of a built-in agent type and configure it via the web interface following the agent's configuration options and inline documentation. With 30+ built-in agents you have the ability to address many common business workflows.
115+
2. If the functionality you wish to achieve isn't directly possible with any of the built-in agents then you can use the (built-in) JavaScript agent which let's you write custom JavaScript code that can send and receive messages.
116+
3. Finally, if none of the above offers you the flexibility or the functionality you wish to achieve you can code and plug-in your own ActiveWorkflow agent. This is currently possible in Ruby and we are working on providing the functionality to code first-class custom agents in other programming languages (Python, JavaScript, Clojure, etc.).
117+
118+
In the near future you'll also be able to programatically create agents via the REST API.
119+
120+
### Creating Workflows
121+
122+
To create a workflow you simply use the web interface (the "New Workflow" button) to enter a name, description, select an icon for your workflow, and then link to it the agents that participate in it. As we have already mentioned agents can participate in multiple workflows and exist independently of them. In this respect a workflow is more like a "tag" or a "label", rather than a "container".
123+
124+
In the near future you'll also be able to programatically create workflows via the REST API.
99125

100126
## Built-in Agents
101127

@@ -283,6 +309,14 @@ API](docs/custom_agent_api.md). Currently agents written in Ruby are supported,
283309
but we are working on providing support for multiple languages, beginning
284310
with Python.
285311

312+
## REST API
313+
314+
ActiveWorkflow provides a REST API to allow you to query and control your
315+
agents and workflows programatically from your own code. We plan to provide
316+
ActiveWorkflow API clients in multiple languages starting with Ruby and Python.
317+
318+
You can read more details about interfacing with ActiveWorkflow programatically in the [REST API documentation](docs/rest_api.md).
319+
286320
## Deployment
287321

288322
### One-Click Heroku Deployment
@@ -292,7 +326,7 @@ The easiest way to start using ActiveWorkflow is by deploying it to
292326

293327
If you are reading this document in a browser all you need to do is click the
294328
button bellow and fill in the environment variables for your seed user (admin):
295-
`SEED_USERNAME`, `SEED_PASSWORD` and `SEED_EMAIL`.
329+
`SEED_USERNAME`, `SEED_PASSWORD` and `SEED_EMAIL`. Please note that `SEED_PASSWORD` must be at least 8 characters long.
296330

297331
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/automaticmode/active_workflow)
298332

@@ -383,14 +417,6 @@ reset Heroku stack to `heroku-18` like this:
383417
heroku stack:set heroku-18
384418
```
385419

386-
## REST API
387-
388-
ActiveWorkflow provides a REST API to allow you to query and control your
389-
agents and workflows programatically from your own code. We plan to provide
390-
ActiveWorkflow API clients in multiple languages starting with Ruby and Python.
391-
You can read more details in the [REST API documentation](docs/rest_api.md).
392-
393-
394420
## Development
395421

396422
### Requirements

0 commit comments

Comments
 (0)