Skip to content

Commit 7ecd5df

Browse files
authored
OZ-340: README as per Ozone's rebranding.
1 parent 225915b commit 7ecd5df

File tree

1 file changed

+11
-59
lines changed

1 file changed

+11
-59
lines changed

README.md

+11-59
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,14 @@
1-
# Ozone EIP Client
1+
<p align="center">
2+
<a href="https://docs.ozone-his.com/"><img src="https://raw.githubusercontent.com/ozone-his/.github/refs/heads/main/profile/ozone-logo.png" alt="Ozone" width="30%"/></a>
3+
</p>
24

3-
[![CI](https://github.com/ozone-his/eip-client/actions/workflows/ci.yml/badge.svg)](https://github.com/ozone-his/eip-client/actions/workflows/ci.yml)
5+
<h3 align="center">The Instant HIS</h3>
46

5-
A generic Spring Boot application designed for executing Apache Camel routes within Ozone. It can be used as a base image for building custom EIP clients. It has support for **_Java DSL_** and **_XML DSL_** routes.
7+
<p align="center">
8+
Welcome to Ozone's open-source repositories!
9+
<br/>Engage with the Ozone community and access useful resources below:
10+
</p>
611

7-
## Getting Started
8-
9-
Follow the instructions below to get a copy of the project up and running on your local machine for development and testing purposes.
10-
11-
1. **Clone the project**
12-
13-
```bash
14-
git clone https://github.com/ozone-his/eip-client.git
15-
```
16-
2. **Build the project**
17-
18-
Navigate to the project directory and build the application using Maven:
19-
20-
```bash
21-
cd eip-client
22-
mvn clean install
23-
```
24-
3. **Run the app**
25-
26-
After building the project, you can run the application using the following command:
27-
28-
```bash
29-
java -jar app/target/eip-client-<version>.jar
30-
```
31-
32-
## Docker Support
33-
34-
### Building a Docker image
35-
36-
```bash
37-
docker build . -t mekomsolutions/eip-client:latest
38-
```
39-
40-
This image can now be consumed in a docker-compose.yml file with:
41-
42-
```yaml
43-
eip-client:
44-
image: mekomsolutions/eip-client:latest
45-
container_name: eip-client
46-
volumes:
47-
- "./path-to-your-configs:/config"
48-
- "./path-to-your-routes:/routes"
49-
- "./eip-home:/eip-home"
50-
ports:
51-
- "8083:8083"
52-
```
53-
54-
### Running the Docker image
55-
56-
```bash
57-
docker run -p 8083:8083 -v ./path-to-your-configs:/config -v ./path-to-your-routes:/routes mekomsolutions/eip-client:latest
58-
```
59-
60-
## License
61-
62-
This project is licensed under the Apache License 2.0 - see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0.txt) file for details.
12+
<h3 align="center">
13+
<a href="https://docs.ozone-his.com/">Docs</a>&nbsp;&nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://talk.openmrs.org/c/software/ozone-his/70">Forum</a>&nbsp;&nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://openmrs.slack.com/archives/C02PYQD5D0A">Chat Room</a>
14+
</h3>

0 commit comments

Comments
 (0)