Skip to content

Update README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 27, 2024
Merged

Update README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Brook

Brook is an orchestration engine, supports microservices and in-app logic (embedded use) orchestration. With the embedded mode, users can effortlessly build their own workflow orchestration engine.

## Getting started

In order to maximize the lightweight nature of the Brook engine, a deliberate separation is made between its core components (which depend solely on a few essential toolkits) and the middleware extensions using SPI (Service Provider Interface). Consequently, regardless of the application implementation framework, one can seamlessly rely on the engine JAR and initialize the relevant instances.

### Maven dependency

#### Not using Spring

```xml
<properties>
<dubbo.version>...</dubbo.version>
Expand All @@ -22,6 +25,7 @@ In order to maximize the lightweight nature of the Brook engine, a deliberate se
```

#### Springboot (recommend)

```xml
<properties>
<dubbo.version>...</dubbo.version>
Expand All @@ -37,6 +41,7 @@ In order to maximize the lightweight nature of the Brook engine, a deliberate se
```

### Maven archetype

For expedited testing.

```shell
Expand All @@ -50,4 +55,8 @@ mvn archetype:generate \
-DarchetypeCatalog=internal
```

The definition of the testing process is located at 'resources/META-INF/flows'.
The definition of the testing process is located at 'resources/META-INF/flows'.

## Contributing

Welcomes anyone that wants to help out in any way, whether that includes reporting problems, helping with documentation, or contributing code changes to fix bugs, add tests, or implement new features. You can report problems to request features in the [GitHub Issues](https://github.com/mytang0/brook/issues).