From 49e0e5dd0f63f83115511639ecd1bbbb889bc32d Mon Sep 17 00:00:00 2001 From: Thomas <54805624+thomas-samoht@users.noreply.github.com> Date: Mon, 4 May 2026 19:14:49 +0200 Subject: [PATCH] Update for archiving --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e4e279f..7233fe6 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,21 @@ The documentation is built using Sphinx. ## Disclaimer -This repository sole purpose is to describe the functionality, structure, and interaction patterns of -the [Generic Functions Modules](https://github.com/minvws/gfmodules-coordination). +This project and all associated code serve solely as documentation +and demonstration purposes to illustrate potential system +communication patterns and architectures. -Please note, this content: +This codebase: -- Is for **informational and internal reference** purposes. -- May not reflect finalized designs or decisions. -- May be updated or restructured without notice. +- Is NOT intended for production use +- Does NOT represent a final specification +- Should NOT be considered feature-complete or secure - May contain errors, omissions, or oversimplified implementations +- Has NOT been tested or hardened for real-world scenarios -By using or referencing this code or documentation, you acknowledge that you do so at your own +The code examples are only meant to help understand concepts and demonstrate possibilities. + +By using or referencing this code, you acknowledge that you do so at your own risk and that the authors assume no liability for any consequences of its use. ## Prerequisites @@ -55,13 +59,12 @@ risk and that the authors assume no liability for any consequences of its use. ## Contribution -This project's sole purpose is to provide documentation for the Generic Functions. +As stated in the [Disclaimer](#disclaimer) this project and all associated code serve solely as documentation and +demonstration purposes to illustrate potential system communication patterns and architectures. -For that reason, we will only accept contributions that fit this goal. We do appreciate any effort from the -community, but because our time is limited, it is possible that your PR or issue is closed without a full justification. +For that reason we will only accept contributions that fit this goal. We do appreciate any effort from the +community, but because our time is limited it is possible that your PR or issue is closed without a full justification. -If you plan to make non-trivial changes, we recommend opening an issue beforehand where we can discuss your planned changes. -This increases the chance that we might be able to use your contribution (or it avoids doing work if there are reasons -why we wouldn't be able to use it). +If you plan to make non-trivial changes, we recommend to open an issue beforehand where we can discuss your planned changes. This increases the chance that we might be able to use your contribution (or it avoids doing work if there are reasons why we wouldn't be able to use it). -Note that all commits should be signed using a GPG key. +Note that all commits should be signed using a gpg key.