diff --git a/README.md b/README.md index 7a5c5e3..f2809d9 100644 --- a/README.md +++ b/README.md @@ -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 ... @@ -22,6 +25,7 @@ In order to maximize the lightweight nature of the Brook engine, a deliberate se ``` #### Springboot (recommend) + ```xml ... @@ -37,6 +41,7 @@ In order to maximize the lightweight nature of the Brook engine, a deliberate se ``` ### Maven archetype + For expedited testing. ```shell @@ -50,4 +55,8 @@ mvn archetype:generate \ -DarchetypeCatalog=internal ``` -The definition of the testing process is located at 'resources/META-INF/flows'. \ No newline at end of file +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). \ No newline at end of file