Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

Commit c9a523a

Browse files
authored
docs: add badges
1 parent 57bc537 commit c9a523a

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# API-Editor
22

3+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/safe-ds/api-editor)](https://github.com/lars-reimann/api-editor/releases/latest)
34
[![Main](https://github.com/lars-reimann/api-editor/actions/workflows/main.yml/badge.svg)](https://github.com/lars-reimann/api-editor/actions/workflows/main.yml)
5+
[![codecov](https://codecov.io/gh/Safe-DS/API-Editor/branch/main/graph/badge.svg?token=xGW2Qs4zXS)](https://codecov.io/gh/Safe-DS/API-Editor)
6+
[![Documentation Status](https://readthedocs.org/projects/api-editor/badge/?version=latest)](https://api-editor.readthedocs.io/en/latest/?badge=latest)
47
[![DOI](https://zenodo.org/badge/365253624.svg)](https://zenodo.org/badge/latestdoi/365253624)
58

69
The `api-editor` is a tool to improve the API of a Python library in a semi-automated manner. Several improvements are suggested automatically and the user can add further improvements manually in a user-friendly GUI. These improvements are implemented automatically by the tool as [_wrappers_][adapter-pattern] that provide the desired API while internally using the existing Python library.
710

811
The automation described above relies on structured information about the existing Python library. This information can be computed automatically by the [package-parser][package-parser].
912

13+
You can find the full documentation [here](https://api-editor.readthedocs.io/en/latest/).
14+
1015
## For Users
1116

1217
1. Install [OpenJDK 17](https://adoptium.net/).

0 commit comments

Comments
 (0)