Skip to content
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.

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

Update README #2

Merged
merged 1 commit into from
Feb 27, 2024
Merged
Changes from all commits
Commits
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
53 changes: 52 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,53 @@
# Brook
Brook is an orchestration engine, supports microservices and in-app logic (embedded use) orchestration.
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>
</properties>

<dependencies>
<dependency>
<groupId>org.mytang.brook</groupId>
<artifactId>>brook-engine</artifactId>
<version>${brook.version}</version>
</dependency>
</dependencies>
```

#### Springboot (recommend)
```xml
<properties>
<dubbo.version>...</dubbo.version>
</properties>

<dependencies>
<dependency>
<groupId>org.mytang.brook</groupId>
<artifactId>>brook-spring-boot-starter</artifactId>
<version>${brook.version}</version>
</dependency>
</dependencies>
```

### Maven archetype
For expedited testing.

```shell
mvn archetype:generate \
-DarchetypeGroupId=org.mytang.brook.demo \
-DarchetypeArtifactId=brook-demo-spring-archetype \
-DarchetypeVersion=1.0.0-SNAPSHOT \
-DgroupId=<my.groupid> \
-DartifactId=<my-artifactId> \
-DinteractiveMode=false \
-DarchetypeCatalog=internal
```

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