From 7ecd5dfe3895998ae965fe1d77477a16206e67b7 Mon Sep 17 00:00:00 2001 From: Dimitri R Date: Thu, 28 Nov 2024 15:15:56 +0100 Subject: [PATCH] OZ-340: README as per Ozone's rebranding. --- README.md | 70 +++++++++---------------------------------------------- 1 file changed, 11 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 98fb17a..892ad11 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,14 @@ -# Ozone EIP Client +

+ Ozone +

-[![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) +

The Instant HIS

-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. +

+ Welcome to Ozone's open-source repositories! +
Engage with the Ozone community and access useful resources below: +

-## Getting Started - -Follow the instructions below to get a copy of the project up and running on your local machine for development and testing purposes. - -1. **Clone the project** - - ```bash - git clone https://github.com/ozone-his/eip-client.git - ``` -2. **Build the project** - - Navigate to the project directory and build the application using Maven: - - ```bash - cd eip-client - mvn clean install - ``` -3. **Run the app** - - After building the project, you can run the application using the following command: - - ```bash - java -jar app/target/eip-client-.jar - ``` - -## Docker Support - -### Building a Docker image - -```bash -docker build . -t mekomsolutions/eip-client:latest -``` - -This image can now be consumed in a docker-compose.yml file with: - -```yaml -eip-client: - image: mekomsolutions/eip-client:latest - container_name: eip-client - volumes: - - "./path-to-your-configs:/config" - - "./path-to-your-routes:/routes" - - "./eip-home:/eip-home" - ports: - - "8083:8083" -``` - -### Running the Docker image - -```bash -docker run -p 8083:8083 -v ./path-to-your-configs:/config -v ./path-to-your-routes:/routes mekomsolutions/eip-client:latest -``` - -## License - -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. +

+ Docs    •    Forum    •    Chat Room +