Skip to content

Commit bc6d1a3

Browse files
d34dmanclaude
andcommitted
docs: update README to reflect v1.4.0 features and fixes
Add missing idea node type (8 total), document theme system and sub-module exports, fix createEndpointConfig signature, update CSS token names to --fd-* prefix, fix CHANGELOG link path, and add Storybook to dev commands. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent edc4b48 commit bc6d1a3

1 file changed

Lines changed: 67 additions & 23 deletions

File tree

libs/flowdrop/README.md

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
<img src="https://raw.githubusercontent.com/flowdrop-io/flowdrop/main/libs/flowdrop/static/logo.svg" alt="FlowDrop" width="120" />
33
</p>
44

5-
<h1 align="center">FlowDrop</h1>
5+
<h1 align="center">FlowDrop</h1>
66

77
<p align="center">
8-
<img src="https://img.shields.io/github/actions/workflow/status/flowdrop-io/flowdrop/docker-publish.yml?style=flat-square&label=Build" alt="GitHub pages build status" />
8+
<img src="https://img.shields.io/github/actions/workflow/status/flowdrop-io/flowdrop/docker-publish.yml?style=flat-square&label=Build" alt="GitHub build status" />
99
<a href="https://www.npmjs.com/package/@flowdrop/flowdrop"><img src="https://img.shields.io/npm/v/@flowdrop/flowdrop?style=flat-square" alt="npm" /></a>
1010
<img src="https://img.shields.io/npm/unpacked-size/%40flowdrop%2Fflowdrop?style=flat-square" alt="NPM Unpacked Size" />
1111
<img src="https://img.shields.io/npm/types/@flowdrop/flowdrop?style=flat-square" alt="npm type definitions" />
12-
<a href="http://npmjs.com/package/@flowdrop/flowdrop"><img src="https://img.shields.io/npm/dt/@flowdrop/flowdrop.svg?maxAge=2592000&style=flat-square" alt="npm downloads" /></a>
12+
<a href="http://npmjs.com/package/@flowdrop/flowdrop"><img alt="NPM Downloads" src="https://img.shields.io/npm/d18m/%40flowdrop%2Fflowdrop"></a>
13+
14+
1315
</p>
1416

1517
<p align="center">
@@ -22,10 +24,10 @@
2224
</p>
2325

2426
<p align="center">
25-
<a href="#quickstart">Quickstart</a> •
27+
<a href="https://docs.flowdrop.io/getting-started/installation">Quickstart</a> •
2628
<a href="#features">Features</a> •
2729
<a href="#integration">Integration</a> •
28-
<a href="#documentation">Docs</a>
30+
<a href="https://docs.flowdrop.io">Docs</a>
2931
</p>
3032

3133
<p align="center">
@@ -70,12 +72,12 @@ You get a production-ready workflow UI. You keep full control of everything else
7072

7173
| | |
7274
| ---------------------------- | ------------------------------------------------------------------------- |
73-
| 🎨 **Visual Editor Only** | Pure UI component. No hidden backend, no external dependencies |
74-
| 🔐 **You Own Everything** | Your data, your servers, your orchestration logic, your security policies |
75-
| 🔌 **Backend Agnostic** | Connect to any API: Drupal, Laravel, Express, FastAPI, or your own |
76-
| 🧩 **7 Built-in Node Types** | From simple icons to complex gateway logic |
77-
| 🎭 **Framework Flexible** | Use as Svelte component or mount into React, Vue, Angular, or vanilla JS |
78-
| 🐳 **Deploy Anywhere** | Runtime config means build once, deploy everywhere |
75+
| **Visual Editor Only** | Pure UI component. No hidden backend, no external dependencies |
76+
| **You Own Everything** | Your data, your servers, your orchestration logic, your security policies |
77+
| **Backend Agnostic** | Connect to any API: Drupal, Laravel, Express, FastAPI, or your own |
78+
| **8 Built-in Node Types** | From simple icons to complex gateway logic |
79+
| **Framework Flexible** | Use as Svelte component or mount into React, Vue, Angular, or vanilla JS |
80+
| **Deploy Anywhere** | Runtime config means build once, deploy everywhere |
7981

8082
## Architecture Notes
8183

@@ -85,7 +87,7 @@ You get a production-ready workflow UI. You keep full control of everything else
8587

8688
## Node Types
8789

88-
FlowDrop ships with 7 beautifully designed node types:
90+
FlowDrop ships with 8 beautifully designed node types:
8991

9092
| Type | Purpose |
9193
| ---------- | --------------------------------------- |
@@ -96,6 +98,7 @@ FlowDrop ships with 7 beautifully designed node types:
9698
| `gateway` | Conditional branching logic |
9799
| `terminal` | Start/end workflow points |
98100
| `note` | Markdown documentation blocks |
101+
| `idea` | Conceptual BPMN-like flow nodes |
99102

100103
<p align="center">
101104
<img src="https://raw.githubusercontent.com/flowdrop-io/flowdrop/main/libs/flowdrop/static/Node-Types.jpg" alt="FlowDrop Node Types" width="800" />
@@ -104,6 +107,49 @@ FlowDrop ships with 7 beautifully designed node types:
104107
<em>From simple triggers to complex branching logic, each node type is designed for specific workflow patterns.</em>
105108
</p>
106109

110+
## Themes
111+
112+
FlowDrop includes a theme system with built-in light/dark support:
113+
114+
```svelte
115+
<script lang="ts">
116+
import { WorkflowEditor } from "@flowdrop/flowdrop";
117+
import "@flowdrop/flowdrop/styles";
118+
</script>
119+
120+
<!-- Built-in themes: 'default' or 'minimal' -->
121+
<WorkflowEditor theme="minimal" />
122+
```
123+
124+
Themes bundle a visual skin (CSS token palette) with behavioral UI defaults. You can also pass a custom theme object with your own skin tokens for full control over the light and dark palettes.
125+
126+
```javascript
127+
// Via the mount API
128+
const app = await mountFlowDropApp(container, {
129+
theme: "minimal",
130+
// or a custom theme object:
131+
// theme: { name: 'minimal', skin: { tokens: { primary: '#e11d48' } } }
132+
});
133+
```
134+
135+
## Sub-Module Exports
136+
137+
FlowDrop provides tree-shakeable sub-module exports so you can import only what you need:
138+
139+
| Export Path | Contents |
140+
| --- | --- |
141+
| `@flowdrop/flowdrop` | Full library (components, stores, services, types) |
142+
| `@flowdrop/flowdrop/core` | Types and utilities only (no heavy dependencies) |
143+
| `@flowdrop/flowdrop/editor` | WorkflowEditor, stores, services |
144+
| `@flowdrop/flowdrop/form` | SchemaForm, form fields, registry |
145+
| `@flowdrop/flowdrop/form/code` | Code editor field (CodeMirror) |
146+
| `@flowdrop/flowdrop/form/markdown` | Markdown editor field |
147+
| `@flowdrop/flowdrop/display` | MarkdownDisplay component |
148+
| `@flowdrop/flowdrop/playground` | Playground components and services |
149+
| `@flowdrop/flowdrop/settings` | SettingsPanel, stores, services |
150+
| `@flowdrop/flowdrop/styles` | Base CSS stylesheet |
151+
| `@flowdrop/flowdrop/schema` | Workflow JSON schema |
152+
107153
## Integration
108154

109155
### Svelte (Native)
@@ -173,8 +219,7 @@ Connect to any backend in seconds:
173219
```typescript
174220
import { createEndpointConfig } from "@flowdrop/flowdrop";
175221

176-
const config = createEndpointConfig({
177-
baseUrl: "https://api.example.com",
222+
const config = createEndpointConfig("https://api.example.com", {
178223
endpoints: {
179224
nodes: { list: "/nodes", get: "/nodes/{id}" },
180225
workflows: {
@@ -185,20 +230,19 @@ const config = createEndpointConfig({
185230
execute: "/workflows/{id}/execute",
186231
},
187232
},
188-
auth: { type: "bearer", token: "your-token" },
189233
});
190234
```
191235

192236
## Customization
193237

194-
Make it yours with CSS custom properties:
238+
The recommended way to customize FlowDrop's appearance is through the [theme system](#themes). For fine-grained control, you can also override individual CSS custom properties:
195239

196240
```css
197241
:root {
198-
--flowdrop-background-color: #0a0a0a;
199-
--flowdrop-primary-color: #6366f1;
200-
--flowdrop-border-color: #27272a;
201-
--flowdrop-text-color: #fafafa;
242+
--fd-background: #0a0a0a;
243+
--fd-primary: #6366f1;
244+
--fd-border: #27272a;
245+
--fd-foreground: #fafafa;
202246
}
203247
```
204248

@@ -225,9 +269,8 @@ Runtime configuration means you build once and deploy to staging, production, or
225269

226270
| Resource | Description |
227271
| ------------------------------------------------------------ | ------------------------ |
228-
| [API Documentation](https://flowdrop-io.github.io/flowdrop/) | REST API specification |
229-
| [Docker Guide](../../apps/example-client-docker/README.md) | Docker deployment guide |
230-
| [QUICK_START.md](./QUICK_START.md) | Get running in 5 minutes |
272+
| [QUICK_START.md](https://docs.flowdrop.io/getting-started/installation/) | Get running in 5 minutes |
273+
| [API Documentation](https://api.flowdrop.io/v1/) | REST API specification |
231274
| [CHANGELOG.md](./CHANGELOG.md) | Version history |
232275

233276
## Development
@@ -237,6 +280,7 @@ pnpm install # Install dependencies
237280
pnpm dev # Start dev server
238281
pnpm build # Build library
239282
pnpm test # Run all tests
283+
pnpm storybook # Launch Storybook
240284
```
241285

242286
## Contributing

0 commit comments

Comments
 (0)