From 13b1055a5f0a1aae1bfd022b7e631c7ac4e4bbc5 Mon Sep 17 00:00:00 2001 From: Ruben Fiszel Date: Mon, 13 Feb 2023 02:26:00 +0100 Subject: [PATCH] update README --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 07924a6633..d4d79311a4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ .

-Open-source developer infrastructure for internal tools. Self-hostable alternative to Airplane, Pipedream, Superblocks and a simplified Temporal with autogenerated UIs to trigger workflows and scripts as internal apps. Scripts are turned into UIs and no-code modules, no-code modules can be composed into very rich flows, and script and flows can be triggered from internal UIs made with a low-code builder. The script languages supported are: Python, Typescript, Go, Bash. +Open-source developer infrastructure for internal tools. Self-hostable alternative to Airplane, Pipedream, Superblocks and a simplified Temporal with autogenerated UIs to trigger workflows and scripts as internal apps. Scripts are turned into UIs and no-code modules, no-code modules can be composed into very rich flows, and script and flows can be triggered from internal UIs made with a low-code builder. The script languages supported are: Python, Typescript, Go, Bash, SQL.

@@ -51,6 +51,7 @@ https://user-images.githubusercontent.com/275584/218350457-bc2fdc3b-e667-4da5-a2 - [Windmill](#windmill) - [Main Concepts](#main-concepts) + - [Show me some actual script code](#show-me-some-actual-script-code) - [CLI](#cli) - [Layout](#layout) - [Stack](#stack) @@ -81,6 +82,23 @@ https://user-images.githubusercontent.com/275584/218350457-bc2fdc3b-e667-4da5-a2 defined in the provided Web IDE or synchronized with your own github repo: ![Step 1](./imgs/windmill-editor.png) +2. Your scripts parameters are automatically parsed and generate a frontend. + ![Step 2](./imgs/windmill-run.png) ![Step 3](./imgs/windmill-result.png) + +3. Make it flow! You can chain your scripts or scripts made by the community + shared on [WindmillHub](https://hub.windmill.dev). + ![Step 4](./imgs/windmill-flow.png) + +4. Build complex UI on top of your scripts and flows. + ![Step 5](./imgs/windmill-builder.png) + +Scripts and flows can also be triggered by a cron schedule '*/5 * * * *' or +through webhooks. + +You can build your entire infra on top of Windmill! + +## Show me some actual script code + ```typescript import * as wmill from "https://deno.land/x/windmill@v1.62.0/mod.ts" //import any dependency from npm @@ -110,21 +128,6 @@ export async function main( } ``` -2. Your scripts parameters are automatically parsed and generate a frontend. - ![Step 2](./imgs/windmill-run.png) ![Step 3](./imgs/windmill-result.png) - -3. Make it flow! You can chain your scripts or scripts made by the community - shared on [WindmillHub](https://hub.windmill.dev). - ![Step 4](./imgs/windmill-flow.png) - -4. Build complex UI on top of your scripts and flows. - ![Step 5](./imgs/windmill-builder.png) - -Scripts and flows can also be triggered by a cron schedule '*/5 * * * *' or -through webhooks. - -You can build your entire infra on top of Windmill! - ## CLI We have a powerful CLI to interact with the windmill platform and sync your