Skip to content

Commit 802faf7

Browse files
author
Vidas P
committed
Use more friendly language for the readme
1 parent b0ae04b commit 802faf7

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
</h3>
55

66
<h3 align="center">
7-
Automate your workflows with autonomous agents<br> in any programming language
7+
Turn complex requirements to workflows<br> without leaving the comfort of your technology stack
88
</h3>
99

1010
<br>
@@ -18,18 +18,25 @@
1818

1919
<h4 align="center">
2020
<a href="#getting-started">Getting Started</a> •
21-
<a href="#usage">Usage</a> •
22-
<a href="#documentation">Documentation</a>
21+
<a href="#system-overview">System Overview</a> •
22+
<a href="https://github.com/automaticmode/active_workflow/wiki">Documentation</a>
2323
</h4>
2424

25+
## About
2526

27+
ActiveWorkflow works alongside your existing technology stack to give you an easy and structured way to:
2628

27-
## About
29+
- **Group business logic for periodic execution**; e.g., generate and distribute
30+
a weekly report.
31+
- **Poll resources**; e.g, check if a file has become available on S3.
32+
- **Orchestrate event-driven functionality**; e.g., trigger a customised
33+
email campaign in reaction to a pattern of user behaviour.
2834

29-
ActiveWorkflow helps you to automate your workflows with [software agents](https://en.wikipedia.org/wiki/Software_agent), autonomous
30-
entities that act on schedule or react to external triggers. These unsupervised agents –which can be written in any programming language– enable you to automate internal or external business, app and product workflows.
35+
You can do all of the above by creating, scheduling, and monitoring workflows of agents, which are self-contained services (or microservices) written in any programming language you choose. ActiveWorkflow gives you a simple way to connect agents to form workflows, extensive logging, state management so that you don't have to worry about a database, and a foundation for scalability and reliability.
3136

32-
<h4 align="center">Connect to APIs • Process Data • Perform Routine Tasks • Send Notifications</h4>
37+
<p><strong>ActiveWorkflow is <u>not</u> a no-code platform</strong>, but does offer a fully featured UI so that both developers and other stakeholders can manage and monitor workflows.
38+
39+
<h4 align="center">Periodic Execution ◆ Polling ◆ Event-Driven Orchestration</h4>
3340

3441
<img src="media/workflows_screenshot.png"
3542
srcset="media/workflows_screenshot@2x.png 2x"
@@ -38,51 +45,45 @@ entities that act on schedule or react to external triggers. These unsupervised
3845
## Getting Started
3946

4047

41-
See the [Getting Started wiki page](https://github.com/automaticmode/active_workflow/wiki/Getting-Started) and follow the simple setup process.
48+
See the [Getting Started wiki page](https://github.com/automaticmode/active_workflow/wiki/Getting-Started) for full details.
49+
50+
If you are in a hurry and wish to take a sneak peek, you can try ActiveWorkflow in one of the following ways.
4251

4352

44-
## Try it with docker
53+
### Try with Docker
4554

4655
```sh
47-
docker run -p 3000:3000 automaticmode/active_workflow
56+
docker run -p 3000:3000 --rm automaticmode/active_workflow
4857
```
4958

5059
Once it starts you can login at [http://localhost:3000](http://localhost:3000) with `admin`/`password`.
5160

52-
## Try it on Heroku
61+
### Try on Heroku
5362

54-
A quick and easy way to check out ActiveWorkflow is by deploying it to
63+
Another quick and easy way to check out ActiveWorkflow is by deploying it on
5564
[Heroku](https://www.heroku.com/).
5665

5766
All you need to do is click the button bellow and fill in the environment variables for your seed user (admin):
5867
`SEED_USERNAME`, `SEED_PASSWORD` (must be at least 8 characters long) and `SEED_EMAIL`.
5968

6069
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/automaticmode/active_workflow&env[SINGLE_DYNO]=1)
6170

62-
**!Note!**: The button above deploys ActiveWorkflow on a single dyno so it could be run using the free Heroku plan. This configuration is not recommended for production. Please see [Getting Started](https://github.com/automaticmode/active_workflow/wiki/Getting-Started#Running-On-Heroku) for more details.
71+
*Note: the button above deploys ActiveWorkflow on a single dyno so that it can use the free Heroku plan. This configuration is not recommended for production, please see [Getting Started](https://github.com/automaticmode/active_workflow/wiki/Getting-Started#Running-On-Heroku) for more details.*
6372

64-
## Usage
73+
## System Overview
6574

66-
Once you have ActiveWorkflow up and running you will want to configure some agents and most probably to arrange them in one or more workflows. You can use ActiveWorkflow via its web interface or its [REST API](https://github.com/automaticmode/active_workflow/wiki/REST-API) as illustrated in the diagram below, where a1–a6 are six agents and w1–w3 are three workflows these agents participate in.
75+
You can use ActiveWorkflow via its web interface or its [REST API](https://github.com/automaticmode/active_workflow/wiki/REST-API) as illustrated in the diagram below. In this example a1–a6 are six agents and w1–w3 are three workflows these agents are part of.
6776

6877
<img src="media/AW_usage_diagram.svg" alt="ActiveWorkflow system overview diagram" />
6978

70-
### Creating Agents
71-
72-
There are currently three ways to create agents, listed below in order of ease:
73-
74-
1. You can create a new instance of a built-in agent and configure it via the web interface following the agent's configuration options and inline documentation. With [30+ built-in agents](https://github.com/automaticmode/active_workflow/wiki/List-of-Built-In-Agents) you have the ability to address many common business workflows.
75-
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 lets you write custom JavaScript code that can send and receive messages.
76-
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. See [How to Create Your Own Custom Agents (with the Remote Agent API)](https://github.com/automaticmode/active_workflow/wiki/Remote-Agent-API) to learn how to do this.
77-
7879
## Documentation
7980

80-
You can find documentation at the [ActiveWorkflow Wiki](https://github.com/automaticmode/active_workflow/wiki).
81+
You can find the full documentation at the [ActiveWorkflow Wiki](https://github.com/automaticmode/active_workflow/wiki).
8182

8283
## Acknowledgements
8384

84-
ActiveWorkflow started as a fork of [Huginn](https://github.com/huginn/huginn) with the
85-
goal of solely targeting business use. ActiveWorkflow is incompatible with Huginn.
85+
ActiveWorkflow started as a fork of [Huginn](https://github.com/huginn/huginn) with
86+
the goal of targeting solely business use, API and polyglot functionality, and a smaller codebase. ActiveWorkflow is incompatible with Huginn.
8687

8788

8889
## License

0 commit comments

Comments
 (0)