Skip to content
This repository was archived by the owner on Feb 15, 2024. It is now read-only.

Commit 2dbaa36

Browse files
committed
Adding documentation to the README
1 parent 58a04e3 commit 2dbaa36

1 file changed

Lines changed: 51 additions & 1 deletion

File tree

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,53 @@
11
# Java Model
22

3-
AAS model implemented in Java
3+
The AAS Java Model is an implementation of the Asset Administration Shell
4+
metamodel in Java. It contains all classes and properties as defined by the
5+
document 'Details of the Asset Administration Shell' published on
6+
[www.plattform-i40.de](https://www.plattform-i40.de).
7+
8+
9+
# Build and Use
10+
11+
You can build the project using Maven by simply executing:
12+
13+
`mvn clean install`
14+
15+
or by integrating the library as a dependency:
16+
17+
```
18+
<dependency>
19+
<groupId>io.admin-shell.aas</groupId>
20+
<artifactId>model</artifactId>
21+
<version>latest-version</version>
22+
<dependency>
23+
```
24+
25+
# Project Structure
26+
27+
The project contains several packages.
28+
29+
- io.adminshell.aas.v3.model: Location of the AAS classes as Java interfaces
30+
- io.adminshell.aas.v3.model.impl: Default implementations of the AAS classes. Can be replaced with custom implementations if needed.
31+
- io.adminshell.aas.v3.model.builder: Provided builder classes to create the instances of the AAS classes
32+
- io.adminshell.aas.v3.dataformat: Interfaces for the serialization formats, for instance JSON, XML, AASX etc. Own serializers can be developed by implementing these interfaces. See also the provided default [serializers](https://github.com/admin-shell-io/java-serializer).
33+
34+
# How to Contribute
35+
36+
We always look for contributions, bug reports, feature requests etc. Simply open an [issue](https://github.com/admin-shell-io/java-model/issues) or - even better - directly propose a change through a [pull request](https://github.com/admin-shell-io/java-model/pulls).
37+
38+
39+
# Contributers
40+
41+
| Name | Affiliation | Github Account |
42+
|:--| -- | -- |
43+
| Sebastian Bader | Fraunhoder IAIS | [sebbader](https://github.com/sebbader) |
44+
| Matthias Böckmann | Fraunhoder IAIS | [maboeckmann](https://github.com/maboeckmann) |
45+
| Chang Qin | Fraunhoder IAIS | [changqin26](https://github.com/changqin26) |
46+
| Michael Jacoby | Fraunhoder IOSB | []() |
47+
| Maximilian Conradi | Fraunhoder IESE | []() |
48+
| Jan-Wilhelm Blume | Fraunhoder IOSB | []() |
49+
| Frank Schnicke | Fraunhoder IESE | []() |
50+
| Jens Müller | Fraunhoder IOSB | []() |
51+
| Daniel Espen | Fraunhoder IESE | []() |
52+
| Bastian Espen | Fraunhoder IOSB | []() |
53+
| Michael Jacoby | Fraunhoder IOSB | []() |

0 commit comments

Comments
 (0)