Skip to content

Commit f91d4f9

Browse files
committed
Make README dark theme compatible
1 parent 4ead97c commit f91d4f9

File tree

6 files changed

+276
-989
lines changed

6 files changed

+276
-989
lines changed

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<h3 align="center">
22
<br>
3-
<a href="https://www.activeworkflow.org"><img src="media/ActiveWorkflow-logo.svg" width="243" /></a>
3+
<a href="https://www.activeworkflow.org"><img src="media/AW.svg" /></a>
44
</h3>
55

66
<h3 align="center">
7-
Turn complex requirements to workflows<br> without leaving the comfort of your technology stack
7+
Turn complex requirements to workflows<br> without leaving the comfort of your technology stack
88
</h3>
99

1010
<br>
@@ -19,24 +19,22 @@
1919
<h4 align="center">
2020
<a href="#getting-started">Getting Started</a> •
2121
<a href="#system-overview">System Overview</a> •
22-
<a href="https://github.com/automaticmode/active_workflow/wiki">Documentation</a>
22+
<a href="https://docs.activeworkflow.org/">Documentation</a>
2323
</h4>
2424

2525
## About
2626

2727
ActiveWorkflow works alongside your existing technology stack to give you an easy and structured way to:
2828

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.
29+
- **Group business logic for periodic execution**—for example, to generate and distribute a weekly PDF report.
30+
- **Poll resources**—for example, to check if a file has become available on S3.
31+
- **Orchestrate event-driven functionality**—for example, to trigger a customised email campaign in reaction to a pattern of user behaviour.
3432

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.
33+
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 as a platform gives you a simple way for connecting your agents (services), extensive logging, state management, and a foundation to build a scalable and reliable system without vendor lock-in.
3634

3735
<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.
3836

39-
<h4 align="center">Periodic Execution ◆ Polling ◆ Event-Driven Orchestration</h4>
37+
<h4 align="center">Periodic Execution ◆ Polling ◆ Orchestration</h4>
4038

4139
<img src="media/workflows_screenshot.png"
4240
srcset="media/workflows_screenshot@2x.png 2x"
@@ -45,7 +43,7 @@ You can do all of the above by creating, scheduling, and monitoring workflows of
4543
## Getting Started
4644

4745

48-
See the [Getting Started wiki page](https://github.com/automaticmode/active_workflow/wiki/Getting-Started) for full details.
46+
See the [Getting Started documentation page](https://docs.activeworkflow.org/) for full details.
4947

5048
If you are in a hurry and wish to take a sneak peek, you can try ActiveWorkflow in one of the following ways.
5149

@@ -68,17 +66,17 @@ All you need to do is click the button bellow and fill in the environment variab
6866

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

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.*
69+
*Note: this configuration is not recommended for production, please see [Getting Started - Running on Heroku](https://docs.activeworkflow.org/#running-on-heroku) for more details.*
7270

7371
## System Overview
7472

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.
73+
You can use ActiveWorkflow via its web interface or its [Client REST API](https://docs.activeworkflow.org/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.
7674

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

7977
## Documentation
8078

81-
You can find the full documentation at the [ActiveWorkflow Wiki](https://github.com/automaticmode/active_workflow/wiki).
79+
You can find the full project documentation at [https://docs.activeworkflow.org](https://docs.activeworkflow.org/).
8280

8381
## Acknowledgements
8482

media/AW.svg

Lines changed: 19 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)