diff --git a/README.md b/README.md index 1c75967b1..500387b89 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # aas-core3.0-java -Manipulate, verify and de/serialize asset administration shells in Java. + +[![CI](https://github.com/aas-core-works/aas-core3.0-java/actions/workflows/ci.yml/badge.svg)](https://github.com/aas-core-works/aas-core3.0-java/actions/workflows/ci.yml) +[![Build Documentation](https://github.com/aas-core-works/aas-core3.0-java/actions/workflows/build-doc.yaml/badge.svg)](https://github.com/aas-core-works/aas-core3.0-java/actions/workflows/build-doc.yaml) + +This is a software development kit (SDK) to manipulate, verify and de/serialize Asset Administration Shells based on the version 3.0 of the meta-model. + +The documentation is available on https://aas-core-works.github.io/aas-core3.0-java/. + +The code has been automatically generated by aas-core-codegen. + +If you want to contribute, please [create a new issue](https://github.com/aas-core-works/aas-core3.0-java/issues/new) first, so that we discuss and synchronize the development.