diff --git a/README.md b/README.md index b8db159..5a2c994 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ # Converters # Overview + This repository contains the source code for the Converters module, which enables the conversion of ISO biometric and document data into standard image formats such as JPEG or PNG. The module exposes API endpoints for configuring and handling conversion operations. ## Build & run (for developers) -The project requires the following: +To build and run the project, ensure you have the following prerequisites installed: + +- Java Development Kit (JDK): Version 21.0.5 -Java Development Kit (JDK): Version 21.0.5 -Maven: Version 3.9.6 +- Apache Maven: Version 3.9.6 + +Follow these below steps to get started: 1. Build and install: - Navigate to the project directory: @@ -40,7 +44,7 @@ Swagger url: [Swagger UI](http://localhost:8098/v1/converter-service/swagger-ui/ 4. Use the jar as library: -```maven +```xml io.mosip.kernel kernel-bio-converter @@ -51,7 +55,13 @@ Swagger url: [Swagger UI](http://localhost:8098/v1/converter-service/swagger-ui/ # Docker Instructions -1. To build a Docker image for a specific service, navigate to the service folder: +Follow these steps to build a Docker image for a specific service: + + + +1. Navigate to the service folder: + +Use the cd command to move to the directory containing the desired service's Dockerfile. ```shell $ cd @@ -103,6 +113,7 @@ Method: POST ## Response: + ```json { "id": "sample-converter",