SemianiakaVY/elsa-core
1
0
Fork 0
Code Issues Pull requests Actions 1 Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Sipke Schoorstra 2025-01-15 11:25:43 +01:00 committed by GitHub
parent 7b45811ef4
commit eba7eb289d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -55,16 +55,13 @@ By default, you can access http://localhost:13000 and log in with:
## Documentation
For comprehensive documentation and to get started with Elsa, please visit the [Elsa Documentation Website](https://v3.elsaworkflows.io/).
[Elsa Documentation Website](https://docs.elsaworkflows.io/).
## Known Issues and Limitations
Elsa is continually evolving, and while it offers powerful capabilities, there are some known limitations and ongoing work:
- Documentation is still a work in progress.
- The designer is not yet fully embeddable in other applications; this feature is planned for a future release.
- C# and Python expressions are not yet fully tested.
- Bulk Dispatch Workflows is a new activity and not yet fully tested.
- Input/Output is not yet implemented in the Workflow Instance Viewer.
- Starting workflows from the designer is currently supported only for workflows that do not require input and do not start with a trigger; this is planned for a future release.
- The designer currently only supports Flowchart activities. Support for Sequence and StateMachine activities is planned for a future release.
@ -90,15 +87,7 @@ Elsa offers a wide range of features for building and executing workflows, inclu
## Roadmap
The following features are planned for future releases of Elsa:
- [ ] Multi-tenancy
- [ ] State Machine activity
- [ ] Designer support for Sequence activity & StateMachine activity
- [ ] BPMN 2.0 support
- [ ] DMN support
- [ ] Workflow migration to new versions via UI
- [ ] Capsules ("hot" deployable workflow packages containing activities and configuration)
See #3232
## Use Cases
@ -109,7 +98,7 @@ Elsa can be used in a variety of scenarios, including:
- Scheduled workflows such as sending daily reports.
- Event-driven workflows such as sending welcome emails when a user signs up.
## Programmatic Workflows
## Coding Workflows
Elsa allows you to define workflows in code using C#. The following example shows how to receive HTTP requests and send an email in response:
@ -141,13 +130,12 @@ public class SendEmailWorkflow : WorkflowBase
}
```
## Designed Workflows
## Designing Workflows
Elsa allows you to define workflows using a visual designer. The following example shows how to receive HTTP requests and send an email in response:
![Elsa ships with a powerful visual designer](./design/screenshots/http-send-email-workflow-designer.png)
## Contributing
We welcome contributions from the community and are pleased that you are interested in helping to improve the Elsa Workflow project! Here are the steps to contribute to our project: