-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
aabd2cf
commit a290cec
Showing
2 changed files
with
14 additions
and
1 deletion.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,15 @@ | ||
![LabelZoom Logo](LabelZoom_Logo_f_400px.png) | ||
|
||
# labelzoom-api | ||
LabelZoom API | ||
|
||
[![Build Status](https://github.com/labelzoom/labelzoom-api/actions/workflows/gradle-build.yml/badge.svg?branch=main)](https://github.com/labelzoom/labelzoom-api/actions?query=branch%3Amain) | ||
|
||
The LabelZoom API is the foundation on which all of LabelZoom's products and services are built. The API serves to define the following: | ||
- **Data model:** [/src/main/java/com/labelzoom/api/model](/src/main/java/com/labelzoom/api/model) - The data model of a LabelZoom label | ||
- **I/O interfaces** | ||
- **Input**: [/src/main/java/com/labelzoom/api/input](/src/main/java/com/labelzoom/api/input) - The LabelReader interface, which can be implemented to convert other types of files into LabelZoom labels | ||
- **Output:** [/src/main/java/com/labelzoom/api/output](/src/main/java/com/labelzoom/api/output) - The LabelWriter interface, which can be implemented to convert LabelZoom labels into other types of files | ||
- **Services:** [/src/main/java/com/labelzoom/api/services](/src/main/java/com/labelzoom/api/services) - Various interfaces that support the implementations of the I/O interfaces | ||
- **Utilities** | ||
- [/src/main/java/com/labelzoom/api/diagnostics](/src/main/java/com/labelzoom/api/diagnostics) - Lightweight utilities to measure the performance of the implemented interfaces | ||
- [/src/main/java/com/labelzoom/api/util](/src/main/java/com/labelzoom/api/util) - Domain-centric utilities aligned to the business domain (e.g. 2D graphics, image manipulation, etc.) |