Skip to content

Commit

Permalink
Update README to include JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
GW1708 authored Dec 16, 2024
1 parent e5be7c8 commit d540b60
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# FA³ST Client [![Maven Build](https://github.com/FraunhoferIOSB/FAAAST-Client/actions/workflows/maven-build.yml/badge.svg?branch=main)](https://github.com/FraunhoferIOSB/FAAST-Client/actions)[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c6e2e44a488d498bab020cf1058c3445)](https://app.codacy.com/gh/FraunhoferIOSB/FAAAST-Client/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)<a href="https://sonarcloud.io/summary/new_code?id=FraunhoferIOSB_FAAAST-Client" ><img src="https://sonarcloud.io/images/project_badges/sonarcloud-white.svg" alt="SonarCloud badge" width="105"/></a>
# FA³ST Client [![Maven Build](https://github.com/FraunhoferIOSB/FAAAST-Client/actions/workflows/maven-build.yml/badge.svg?branch=main)](https://github.com/FraunhoferIOSB/FAAST-Client/actions)[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c6e2e44a488d498bab020cf1058c3445)](https://app.codacy.com/gh/FraunhoferIOSB/FAAAST-Client/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)[![javadoc](https://javadoc.io/badge2/de.fraunhofer.iosb.ilt.faaast.client/core/javadoc.svg)](https://javadoc.io/doc/de.fraunhofer.iosb.ilt.faaast.client/core)<a href="https://sonarcloud.io/summary/new_code?id=FraunhoferIOSB_FAAAST-Client" ><img src="https://sonarcloud.io/images/project_badges/sonarcloud-white.svg" alt="SonarCloud badge" width="105"/></a>

![FAAAST-Client Logo](misc/images/Fa3st-Client_negativ.png)

The **F**raunhofer **A**dvanced **A**sset **A**dministration **S**hell **Tools** (**FA³ST**) Client is a Java-based client
library for version 3.0.1 of the [AAS API](https://github.com/admin-shell-io/aas-specs-api/tree/v3.0.1) and
aims to simplify development of AAS client applications. See also the [OpenAPI](https://app.swaggerhub.com/apis/Plattform_i40/Entire-API-Collection/V3.0.1) Documentation.
For detailed documentation see [JavaDoc](https://javadoc.io/doc/de.fraunhofer.iosb.ilt.faaast.client/core/latest/index.html).

## Usage

Expand Down Expand Up @@ -271,4 +272,4 @@ Distributed under the Apache 2.0 License. See `LICENSE` for more information.

Copyright (C) 2024 Fraunhofer Institut IOSB, Fraunhoferstr. 1, D 76131 Karlsruhe, Germany.

You should have received a copy of the Apache 2.0 License along with this program. If not, see https://www.apache.org/licenses/LICENSE-2.0.html.
You should have received a copy of the Apache 2.0 License along with this program. If not, see https://www.apache.org/licenses/LICENSE-2.0.html.

0 comments on commit d540b60

Please sign in to comment.