Merge pull request #4 from FlorianDue/main

Fix Typos and add link to docu

Author: FlorianDue

README.md

@@ -1,26 +1,41 @@
 # SWAP-IT Registry Module
 The SWAP-IT Registry Module is a base module of the SWAP-IT Architecture (https://github.com/swap-it/demo-scenario). The module is supposed to map server of SWAP-Assets and thus,
-make them available for process execution steps. Doing so, the Registry Module provides three main functionalities, 
+make them available for process execution steps. Doing so, the Registry Module provides three main functionalities,
 which can be accessed through OPC UA Method calls:
 
-1. **Register Asset:** The addition of an Asset to the Registry Module. The Data Values are mapped to the registry module and the 
-asset can be considered for process execution steps within the SWAP-IT Architecture.
-    
-2. **Unregister Asset:** The removal of an Asset from the Registry Module. The Data Values are no longer mapped to the registry module and the 
-asset cannot be considered for process execution steps within the SWAP-IT Architecture anymore.
+1. **Register Asset:** The addition of an Asset to the Registry Module. The Data Values are mapped to the registry module and the
+   asset can be considered for process execution steps within the SWAP-IT Architecture.
+
+2. **Unregister Asset:** The removal of an Asset from the Registry Module. The Data Values are no longer mapped to the registry module and the
+   asset cannot be considered for process execution steps within the SWAP-IT Architecture anymore.
+
+3. **Filter Asset:** Provision of assets to the swap-it-execution-engine from a set of registered assets. The Filter Asset Method can
+   evaluate product capabilities and match them against asset capabilities.
+
+
+<img src="documentation/source/images/registry_overview.png" alt="">
+
+
+An extensive documentation or the SWAP-IT Registry Module can be found here: https://fraunhoferiosb.github.io/swap-it-registry-module
+or build from the repository. Here, sphinx and the sphinx rtd theme are required. Both can be installed with:
+
+    pip install sphinx 
+    pip install sphinx-rtd-theme
 
-3. **Filter Asset:** Provision of assets to the swap-it-execution-engine from a set of registered assets. The Filter Asset Method can 
-evaluate product capabilities and match them against asset capabilities.
 
-<p align="center">
-    <img src="documentation/source/images/registry_overview.png" alt="">
-</p>
+Build the documentation:
+
+    cd swap-it-registry-module
+    #html
+    sphinx-build -M html documentation/source/ documentation/build/html
+    #pdf
+    sphinx-build -b pdf documentation/source/ documentation/build/pdf/
+
 
 ## Dependencies
-The SWAP-IT Regitry Module requires a locally installed version of the C-based OPC UA SDK open62541 (https://github.com/open62541/open62541) version 1.4.6, 
+The SWAP-IT Registry Module requires a locally installed version of the C-based OPC UA SDK open62541 (https://github.com/open62541/open62541) version 1.4.6,
 as well as a locally installed version of the  swap-it-open62541-server-template (https://github.com/FraunhoferIOSB/swap-it-open62541-server-template).
 
-For the installation of the dependencies, see section Build the Registry-Module
 
 ## Build the Registry-Module:
 
@@ -58,7 +73,7 @@ The default URL of the registry module is: **opc.tcp://localhost:8000**
     ./swap-it-registry-module
 
 ## Related Projects
-Since the SWAP-IT Regitry Module is part of the SWAP-IT Architecture, its application is linked to other SWAP-IT projects. Here are some other relevant repositories:
+Since the SWAP-IT Registry Module is part of the SWAP-IT Architecture, its application is linked to other SWAP-IT projects. Here are some other relevant repositories:
 
 - SWAP-IT Demo Scenario: https://github.com/swap-it/demo-scenario
 - SWAP-IT open62541 server-template: https://github.com/FraunhoferIOSB/swap-it-open62541-server-template
@@ -67,18 +82,3 @@ Since the SWAP-IT Regitry Module is part of the SWAP-IT Architecture, its applic
 - SWAP-IT Dashboard: https://github.com/iml130/swap-it-dashboard
 - Common Information Model: https://github.com/FraunhoferIOSB/swap-it-common-information-model
 
-## Build Documentation
-
-To build the documentation, sphinx and the sphinx rtd theme are required. Both can be installed with:
-
-    pip install sphinx 
-    pip install sphinx-rtd-theme
-
-
-Build the documentation:
-
-    cd swap-it-registry-module
-    #html
-    sphinx-build -M html documentation/source/ documentation/build/html
-    #pdf
-    sphinx-build -b pdf documentation/source/ documentation/build/pdf/

documentation/source/unregister.rst

@@ -12,7 +12,7 @@ Unregister SWAP Assets
 There are several ways to unregister SWAP Assets within the Registry Module:
 - Remove Agent Method within the Registry Module
 - Unregister Method from the `Common Information Model <https://github.com/FraunhoferIOSB/swap-it-common-information-model>`_ (the method callback is provided within the `open62541-server-template <https://github.com/FraunhoferIOSB/swap-it-open62541-server-template>`_)
-- Json Configuration of the `open62541-server-template <https://github.com/FraunhoferIOSB/swap-it-open62541-server-template>`_. However, this approach automatically unregisters the agent when shutting down the server, so that no code example will be provided. The code example is availabe at `Registration`. The server must just be shut down for the un-registration.
+- Json Configuration of the `open62541-server-template <https://github.com/FraunhoferIOSB/swap-it-open62541-server-template>`_. However, this approach automatically unregisters the agent when shutting down the server, so that no code example will be provided. The code example is available at `Registration`. The server must just be shut down for the un-registration.
 
 First, the Registry Module must be started: