Skip to content

Commit

Permalink
Merge pull request #3 from mytang0/readme
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
mytang0 committed Feb 27, 2024
2 parents f16226d + 180cd4b commit 200b59d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
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).

0 comments on commit 200b59d

Please sign in to comment.