diff --git a/README.md b/README.md index 7ab6b953b..6f1f058c2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ ## Elsa Workflows -Elsa Workflows is a set of lean & mean workflowing components that you can use in your own .NET Core applications. It provides core workflowing functionality, a web-based designer and workflow runtimes. +Elsa Workflows is a set of lean & mean workflowing components that you can use in your own .NET Core applications. It's heavily inspired by Orchard Core Workflows, Azure Logic Apps and Windows Workflow Foundation, but with some key differentiators. + +TODO: +- Describe all the features (core engine, runtime, webbased designer, YAML, scripting, separation of designer from invoker from engine). +- Describe various use cases. +- Describe how to use. +- Describe how to implement (custom host, custom dashboard). +- Implement more activities (fork, join, script, HTTP request, loops, etc.) +- Implement integration with Orchard Core (separate repo) +- Detailed documentation ![Web-based workflow designer](/doc/workflow-sample-1.png)