Skip to content

Commit 6cacb6e

Browse files
author
Vidas P
committed
Update README with screenshot of docs
1 parent d51f180 commit 6cacb6e

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

README.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
<h4 align="center">
2020
<a href="#getting-started">Getting Started</a> •
21-
<a href="#system-overview">System Overview</a> •
2221
<a href="https://docs.activeworkflow.org/">Documentation</a>
2322
</h4>
2423

@@ -32,13 +31,13 @@ ActiveWorkflow works alongside your existing technology stack to give you an eas
3231

3332
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.
3433

35-
<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.
34+
ActiveWorkflow **is not a no-code platform**, but it does offer a fully featured UI so that both software engineers and other stakeholders can manage and monitor workflows.
3635

3736
<h4 align="center">Periodic Execution ◆ Polling ◆ Orchestration</h4>
3837

3938
<img src="media/workflows_screenshot.png"
4039
srcset="media/workflows_[email protected] 2x"
41-
alt="Main view">
40+
alt="Screenshot of ActiveWorkflow">
4241

4342
## Getting Started
4443

@@ -48,15 +47,15 @@ See the [Getting Started documentation page](https://docs.activeworkflow.org/) f
4847
If you are in a hurry and wish to take a sneak peek, you can try ActiveWorkflow in one of the following ways.
4948

5049

51-
### Try with Docker
50+
### Try it with Docker
5251

5352
```sh
5453
docker run -p 3000:3000 --rm automaticmode/active_workflow
5554
```
5655

57-
Once it starts you can login at [http://localhost:3000](http://localhost:3000) with `admin`/`password`.
56+
Once it starts you can login at `http://localhost:3000` with `admin`/`password`.
5857

59-
### Try on Heroku
58+
### Try it on Heroku
6059

6160
Another quick and easy way to check out ActiveWorkflow is by deploying it on
6261
[Heroku](https://www.heroku.com/).
@@ -68,15 +67,14 @@ All you need to do is click the button bellow and fill in the environment variab
6867

6968
*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.*
7069

71-
## System Overview
72-
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.
74-
75-
<img src="media/AW_usage_diagram.svg" alt="ActiveWorkflow system overview diagram" />
76-
7770
## Documentation
7871

79-
You can find the full project documentation at [https://docs.activeworkflow.org](https://docs.activeworkflow.org/).
72+
You can find the full project documentation at [docs.activeworkflow.org](https://docs.activeworkflow.org/).
73+
74+
<a href="https://docs.activeworkflow.org/">
75+
<img src="media/documentation_screenshot.png"
76+
srcset="media/documentation_[email protected] 2x"
77+
alt="Screenshot of documentation"></a>
8078

8179
## Acknowledgements
8280

media/documentation_screenshot.png

202 KB
Loading

media/[email protected]

547 KB
Loading

0 commit comments

Comments
 (0)