Skip to content

Commit a3b9d67

Browse files
committed
added information to README
1 parent 018931b commit a3b9d67

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# Mapping-Service
22

33
[![Java CI with Gradle](https://github.com/maximilianiKIT/mapping-service/actions/workflows/CI.yml/badge.svg)](https://github.com/maximilianiKIT/mapping-service/actions/workflows/CI.yml)
4-
![License](https://img.shields.io/github/license/kit-data-manager/indexing-service.svg)
4+
[![CodeQL](https://github.com/maximilianiKIT/mapping-service/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/maximilianiKIT/mapping-service/actions/workflows/codeql-analysis.yml)
55
[![codecov](https://codecov.io/gh/maximilianiKIT/mapping-service/branch/main/graph/badge.svg?token=XFhZruKFaE)](https://codecov.io/gh/maximilianiKIT/mapping-service)
6+
[![License](https://img.shields.io/github/license/kit-data-manager/indexing-service.svg)](https://github.com/maximilianiKIT/mapping-service/blob/c3ab1c96643b3409774eafd4c8f0843cb9ae2aa1/LICENSE)
67

78
:warning:
89
Not fully tested yet!
10+
The mapping-service provides a generic interface for mapping various documents.
11+
The tools required for this, such as Gemma, JOLT, XSLT, ... can be loaded into the mapping-service as plugins, regardless of the programming language in which they were developed.
12+
These tools are then made usable via the REST-API and a Web-UI.
13+
The mapping schemas are stored in a database and can be managed via the REST-API and the Web-UI.
914

10-
The mapping service allows multiple schemas to be uploaded and managed and documents to be mapped over one of them at a time accordingly.
11-
Therefore, the service is extensible to other mappers, although currently only Gemma, a service that can only map JSON files, is available.
12-
The REST API is documented at the following link: [http://localhost:8095/swagger-ui/index.html](http://localhost:8095/swagger-ui/index.html)
15+
The Web-UI is accessible via the following URL: [http://\<IP or hostname>:8095](http://localhost:8095)
16+
The REST-API is documented at the following link: [http://\<IP or hostname>:8095/swagger-ui/index.html](http://localhost:8095/swagger-ui/index.html)
1317

1418
## How to build
1519

0 commit comments

Comments
 (0)