Skip to content

Commit 1a799b1

Browse files
author
Christian Lüthold
committed
Update README.md
added installation description
1 parent ec7db1f commit 1a799b1

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,30 @@ This is a lightweight and extensible framework for asynchronous and synchronous
2323

2424
Coming soon!
2525

26+
## Installation
27+
There are three easy ways to get and include the Hive2Hive Process Framework into your project.
28+
29+
If you just want to use the framework, either refer to option 1 or 2.
30+
If you want to [contribute to the project](#contribution), please refer to option 3.
31+
- **Option 1: Add Maven dependency** *(recommended)*
32+
You can add the latest stable release as an [Apache Maven](http://maven.apache.org/) dependency and fetch it from our repository. Add the following to your `pom.xml` and make sure to select the most recent version.
33+
```xml
34+
<repository>
35+
<id>hive2hive.org</id>
36+
<url>http://repo.hive2hive.org</url>
37+
</repository>
38+
...
39+
<dependency>
40+
<groupId>org.hive2hive</groupId>
41+
<artifactId>org.hive2hive.processframework</artifactId>
42+
<version>1.X.X</version>
43+
</dependency>
44+
```
45+
- **Option 2: Add JAR-file directly**
46+
In case you don't want to use Maven, you can just download the [latest stable release](https://github.com/Hive2Hive/ProcessFramework/releases). The required `.jar`-files is packed and delivered to you as a `.zip`.
47+
- **Option 3: Clone from GitHub**
48+
If you want to contribute to the Hive2Hive ProcessFramework project, this is what you should do. Cloning from the `dev` branch allows yout to get the *bleeding edge* of development. This option is not recommended if you just want to use the library.
49+
2650
## Documentation
2751

2852
For more exact details and documentation about this process library, please visit http://hive2hive.com/process-framework/.

0 commit comments

Comments
 (0)