Skip to content

Commit 6e67577

Browse files
authored
Update README.md
1 parent 40c4b07 commit 6e67577

File tree

1 file changed

+73
-34
lines changed

1 file changed

+73
-34
lines changed

README.md

Lines changed: 73 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
11
<img alt="Workflow Builder" src="https://cdn.synergycodes.com/workflow-builder-logo-solid.svg" width="201" height="40">
22

3-
Workflow Builder is a frontend-first foundation for creating complex workflow editors. Designed for hassle-free integration with any backend, it delivers everything you need to design workflows faster – from drag-and-drop nodes to customizable layouts.
3+
## What is Workflow Builder?
44

5-
[![Build](https://github.com/synergycodes/workflowbuilder/actions/workflows/build.yml/badge.svg)](https://github.com/synergycodes/workflowbuilder/actions/workflows/build.yml)
5+
Workflow Builder is an open-source, frontend-only SDK for building and embedding visual workflow editors into your application.
66

7-
# Workflow Builder
8-
9-
## Table of Contents
10-
11-
<ol>
12-
<li>
13-
<a href="#about-the-project">About The Project</a>
14-
<ul>
15-
<li><a href="#technical-overview">Technical Overview</a></li>
16-
</ul>
17-
</li>
18-
<li>
19-
<a href="#getting-started">Getting started</a>
20-
<ul>
21-
<li><a href="#prerequisites">Prerequisites</a></li>
22-
<li><a href="#installation">Installation</a></li>
23-
</ul>
24-
</li>
25-
<li>
26-
<a href="#decision-logs">Decision Logs</a>
27-
</li>
28-
</ol>
7+
It provides a ready-made workflow editor UI - including canvas, nodes, edges, layout and configuration panels - so you don’t have to build workflow UX from scratch.
298

30-
## <a name="about-the-project">About The Project</a>
9+
Workflow Builder focuses exclusively on the **frontend editor layer**.
10+
Execution, orchestration, and business logic remain fully under your control.
3111

32-
Monorepo of [Workflow Builder](https://www.workflowbuilder.io/) - a white-label template tailored for development of workflow based apps.
12+
## What Workflow Builder is NOT
3313

34-
### <a name="technical-overview">Technical Overview</a>
14+
Workflow Builder does **not**:
15+
- execute workflows
16+
- provide scheduling or orchestration
17+
- include backend logic or integrations
18+
- act as an iPaaS or automation platform
3519

36-
Using `pnpm workspaces` Workflow Builder is split into packages placed in `apps/` directory:
20+
The SDK outputs workflow definitions (JSON) that are meant to be executed by **your own backend**.
3721

38-
- [`frontend`](./apps/frontend/README.md) - React app containing the core functionality of Workflow Builder
39-
- [`frontend-e2e`](./apps/frontend-e2e/README.md) - E2E tests for the frontend
40-
- [`types`](./apps/types/README.md) - Shared Typescript definitions for the project
41-
- [`icons`](./apps/icons/README.md) - Lazy-loadable, extensible icons
22+
## Key features
23+
24+
- Visual workflow editor (nodes, edges, layout, validation)
25+
- Configurable and extensible node system
26+
- Schema-driven properties panels
27+
- Workflow serialization to JSON
28+
- Plugin-first architecture
29+
- Back-end agnostic
30+
- Designed for embedding into SaaS products
31+
- Theming and white-label support
32+
- Design System Kit
33+
34+
## Typical use cases
35+
36+
Workflow Builder is commonly used to:
37+
- embed workflow editors into B2B SaaS products
38+
- build visual rule engines and configuration tools
39+
- design AI agent and automation workflow platforms
40+
- serve as a foundation for workflow-driven products and standalone apps
41+
42+
[![Build](https://github.com/synergycodes/workflowbuilder/actions/workflows/build.yml/badge.svg)](https://github.com/synergycodes/workflowbuilder/actions/workflows/build.yml)
43+
44+
## <a name="about-the-project">About The Project</a>
45+
46+
Monorepo of [Workflow Builder](https://www.workflowbuilder.io/) - a frontend-first SDK and foundation for building workflow-driven applications.
4247

4348
## <a name="getting-started">Getting Started</a>
4449

@@ -54,11 +59,45 @@ You'll need `node` and `pnpm` with proper versions set in the root `package.json
5459
3. To start the app, run
5560
`pnpm dev`
5661

62+
### <a name="technical-overview">Technical Overview</a>
63+
64+
Using `pnpm workspaces` Workflow Builder is split into packages placed in `apps/` directory:
65+
66+
- [`frontend`](./apps/frontend/README.md) - React app containing the core functionality of Workflow Builder
67+
- [`frontend-e2e`](./apps/frontend-e2e/README.md) - E2E tests for the frontend
68+
- [`types`](./apps/types/README.md) - Shared Typescript definitions for the project
69+
- [`icons`](./apps/icons/README.md) - Lazy-loadable, extensible icons
70+
5771
## <a name="decision-logs">Decision Logs</a>
5872

5973
To document technical choices and provide an overview of reasoning behind them, the repo contains `*.decision-log.md` files that live along the code and packages their related to. See [decision logs list](./DECISION-LOGS.md)
6074

75+
## License
76+
77+
Community Edition:
78+
- Open source
79+
- Apache 2.0 license
80+
- Frontend-only workflow editor SDK
81+
82+
Enterprise Edition:
83+
- Commercial license
84+
- Long-term support
85+
- Advanced features and professional services
86+
87+
## Contributing
88+
Workflow Builder is open-source and we welcome contributions. Whether you're fixing bugs, proposing features, improving docs, or spreading the word - we'd love to have you as part of the community.
89+
90+
## Professional consulting & enterprise support
91+
Workflow Builder is a frontend-only SDK. For enterprise companies that need end-to-end implementations, we also offer professional consulting services.
92+
Our team can help with:
93+
- backend execution engines
94+
- custom integrations
95+
- enterprise-grade customization and scaling
96+
- accelerating time-to-market with proven architecture patterns
97+
The team behind Workflow Builder has 15+ years of experience building enterprise-class diagramming and automation tools.
98+
Learn more about Enterprise Edition and consulting: 👉 https://workflowbuilder.io
99+
61100
## <a name="links">Links</a>
62101

63-
- [Product landing page](https://www.workflowbuilder.io/)
64-
- [Publicly available web app](https://app.workflowbuilder.io/)
102+
- [Product website](https://www.workflowbuilder.io/)
103+
- [Try interactive sample demo](https://app.workflowbuilder.io/)

0 commit comments

Comments
 (0)