Skip to content

Commit

Permalink
Improves the main README (#595)
Browse files Browse the repository at this point in the history
* Fixes Web UIs Registry and Discovery Endpoint Env Vars

* Improves the README
  • Loading branch information
aaronzi authored Jan 20, 2025
1 parent 9d18b6e commit 0a7a5d5
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@

In this repository, the BaSyx Java V2 components fully compatible with *Details of the Asset Administration Shell V3* are as well as their respective Clients are contained. For each component, a multitude of backends (e.g., InMemory, MongoDB) as well as further features (MQTT, ...) are provided. All components are available on [DockerHub](https://hub.docker.com/search?q=eclipsebasyx) as off-the-shelf components and can be easily configured and extended. Additionally, the server SDK of this repository can be used for implementation of further components.

## Get started with our off-the-shelf components

> [!IMPORTANT]
> We provide a **[Starter Kit](https://basyx.org/get-started/introduction)** on [BaSyx.org](https://basyx.org) that can be used to create your first running BaSyx setup tailored to your needs.
> All configurations can be done graphically with ease.
> [!NOTE]
> If you need a minimal example, we also provide one [here](examples/BaSyxMinimal) in our collection of [BaSyx examples](examples).
## Server SDK
The following off-the-shelf components are available:

Expand All @@ -13,6 +22,7 @@ The following off-the-shelf components are available:
* [AAS Registry](basyx.aasregistry)
* [Submodel Registry](basyx.submodelregistry)
* [AAS Discovery](basyx.aasdiscoveryservice)
* [AASX File Server](basyx.aasxfileserver)

In addition, a blueprint for a Type 2/ Type 3 standalone submodel is provided:
* [Type 2/Type 3 Submodel](basyx.submodelservice)
Expand All @@ -23,6 +33,9 @@ In addition, the following Clients are available:
* [Submodel Repository Client](basyx.submodelrepository/basyx.submodelrepository-client)
* [AAS Service Client](basyx.aasservice/basyx.aasservice-client)
* [Submodel Service Client](basyx.submodelservice/basyx.submodelservice-client)
* [AAS Environment Client](basyx.aasenvironment/basyx.aasenvironment-client)
* [AAS Registry Client](basyx.aasregistry/basyx.aasregistry-client-native)
* [Submodel Registry Client](basyx.submodelregistry/basyx.submodelregistry-client-native)

## Documentation, Roadmap & Examples
In addition to the [general documentation](https://github.com/eclipse-basyx/basyx-java-server-sdk/tree/main/docs), each component has its own specific documentation that can be found in the respective folders. Additionally, we provide a general documentation on [readthedocs](https://wiki.basyx.org/en/latest/).
Expand Down

0 comments on commit 0a7a5d5

Please sign in to comment.