diff --git a/README.md b/README.md index 5a34645265..bdf83de262 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- windmill.dev + windmill.dev

Windmill.dev is an OSS developer platform to quickly build production-grade multi-steps automations and internal apps from minimal Python and Typescript scripts. @@ -36,13 +36,32 @@ You can show your support for the project by starring this repo. especially concerning flows.

-![Windmill Screenshot](./windmill.webp) +![Windmill Screenshot](./imgs/windmill.webp) Windmill is fully open-sourced: - `community/` and `python-client/` are Apache 2.0 - backend, frontend and everything else under AGPLv3. +## What is the general idea behind Windmill + +1. Define a minimal and generic script in Python or Typescript that solve a + specific task. Here sending an email with SMTP. The code can be defined in + the provided Web IDE or synchronizing with your own github repo: + ![Step 1](./imgs/step1.png) + +2. Your scripts parameters are automatically parsed and generate a frontend. You + can narrow down the types during task definition to specify regex for string, + an enum or a specific format for objects. Each script correspond to an app by + itself: ![Step 2](./imgs/step2.png) + +3. Make it flow! You can chain your scripts or scripts made by the community + inside flow by piping output to input using "Dynamic" fields that are just + plain Javascript. You can also refer to external variables, output from any + steps or inputs of the flow itself. The flow parameters then generate + automatically an intuitive forms that can be triggered by anyone, like for + scripts. ![Step 3](./imgs/step3.png) + ## Layout - `backend/`: The whole Rust backend @@ -76,7 +95,7 @@ Windmill is fully open-sourced: ## Architecture -![Architecture](./architecture.svg) +![Architecture](./imgs/architecture.svg) ## How to self-host diff --git a/architecture.svg b/imgs/architecture.svg similarity index 100% rename from architecture.svg rename to imgs/architecture.svg diff --git a/imgs/step1.png b/imgs/step1.png new file mode 100644 index 0000000000..63ec381060 Binary files /dev/null and b/imgs/step1.png differ diff --git a/imgs/step2.png b/imgs/step2.png new file mode 100644 index 0000000000..d48b1323a6 Binary files /dev/null and b/imgs/step2.png differ diff --git a/imgs/step3.png b/imgs/step3.png new file mode 100644 index 0000000000..8db759012a Binary files /dev/null and b/imgs/step3.png differ diff --git a/windmill.svg b/imgs/windmill.svg similarity index 100% rename from windmill.svg rename to imgs/windmill.svg