Update README.md

This commit is contained in:
Sipke Schoorstra 2021-02-11 10:22:30 +01:00 committed by GitHub
parent eb3e22c62d
commit abcf4e5fa9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -64,14 +64,12 @@ Version 3.0
## Workflow Designer
Workflows can be visually designed using [Elsa Designer](https://github.com/elsa-workflows/elsa-designer-html), a reusable & extensible HTML5 web component built with [StencilJS](https://stenciljs.com/).
Workflows can be visually designed using the Elsa Designer, a reusable & extensible HTML5 web component built with [StencilJS](https://stenciljs.com/).
To manage workflow definitions and instances, Elsa comes with a reusable Razor Class Library that provides a dashboard application in the form of an MVC area that you can include in your own ASP.NET Core application.
![Web-based workflow designer](/doc/dashboard-sample-1.png)
## Programmatic Workflows
Workflows can be created programmatically and then executed using `IWorkflowRunner`.
Workflows can be created programmatically and then executed using `IWorkflowRunner` or scheduled for execution using `IWorkflowQueue`.
### Hello World
The following code snippet demonstrates creating a workflow with two WriteLine activities from code and then invoking it:
@ -122,12 +120,14 @@ This models is then serialized to JSON and deserialized back into the model
var services = new ServiceCollection()
.AddElsa()
// For tests
.AddElsaPersistenceInMemory()
// For productive use
.AddElsaPersistenceYesSql((sp, config) => config.UseSqLite("Data Source=elsa.db;Cache=Shared", IsolationLevel.ReadUncommitted))
.AddConsoleActivities()
// For production use.
.UseYesSqlPersistence()
// Or use any of the other supported persistence providers such as EF Core or MongoDB:
// .UseEntityFrameworkPersistence(ef => ef.UseSqlite())
// .UseMongoDbPersistence()
.BuildServiceProvider();
// Run startup actions (not needed when registering Elsa with a Host).
@ -183,7 +183,7 @@ await workflowRunner.RunWorkflowAsync(workflowBlueprint);
## Persistence
Elsa uses [YesSql](https://github.com/sebastienros/yessql) as the ORM of choice for data access, offering the most flexibility in terms of custom querying capabilities (using map/reduce index providers).
Elsa abstractes away data access, which means you can use any persistence provider you prefer.
## Long Running Workflows