diff --git a/README.md b/README.md index b7579cd..2789807 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ [![Documentation Status](https://readthedocs.org/projects/pydase/badge/?version=latest)](https://pydase.readthedocs.io/en/latest/?badge=stable) [![License: MIT](https://img.shields.io/github/license/tiqi-group/pydase)](https://github.com/tiqi-group/pydase/blob/main/LICENSE) -`pydase` is a Python library that simplifies the creation of remote control interfaces for Python objects. It exposes the public attributes of a user-defined class via a Socket.IO web server, ensuring they are always in sync with the service state. You can interact with these attributes using an RPC client, a RESTful API, or a web browser. The web browser frontend is auto-generated, displaying components that correspond to each public attribute of the class for direct interaction. -`pydase` implements an observer pattern and to provide real-time updates, ensuring that changes to the class attributes are reflected across all clients. +`pydase` is a Python library that simplifies the creation of remote control interfaces for Python objects. It exposes the public attributes of a user-defined class via a [Socket.IO](https://python-socketio.readthedocs.io/en/stable/) web server, ensuring they are always in sync with the service state. You can interact with these attributes using an RPC client, a RESTful API, or a web browser. The web browser frontend is auto-generated, displaying components that correspond to each public attribute of the class for direct interaction. +`pydase` implements an [observer pattern][Observer Pattern] to provide the real-time updates, ensuring that changes to the class attributes are reflected across all clients. Whether you're managing lab sensors, network devices, or any abstract data entity, `pydase` facilitates service development and deployment. @@ -419,6 +419,7 @@ We welcome contributions! Please see [contributing.md](https://pydase.readthedoc `pydase` is licensed under the [MIT License](https://github.com/tiqi-group/pydase/blob/main/LICENSE). +[Observer Pattern]: https://pydase.readthedocs.io/en/docs/dev-guide/Observer_Pattern_Implementation/ [Service Persistence]: https://pydase.readthedocs.io/en/stable/user-guide/Service_Persistence [Defining DataService]: #defining-a-dataService [Web Interface Access]: #accessing-the-web-interface diff --git a/docs/dev-guide/Observer_Pattern_Implementation.md b/docs/dev-guide/Observer_Pattern_Implementation.md index cb78a1e..8b9e072 100644 --- a/docs/dev-guide/Observer_Pattern_Implementation.md +++ b/docs/dev-guide/Observer_Pattern_Implementation.md @@ -2,7 +2,7 @@ ## Overview -The Observer Pattern is a fundamental design pattern in the `pydase` package, serving as the central communication mechanism for state updates to clients connected to a service. +The [Observer Pattern](https://en.wikipedia.org/wiki/Observer_pattern) is a fundamental design pattern in the `pydase` package, serving as the central communication mechanism for state updates to clients connected to a service. ## How it Works diff --git a/docs/index.md b/docs/index.md index 8fffdb9..8f6acf0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,7 @@ end="" %} +[Observer Pattern]: ./dev-guide/Observer_Pattern_Implementation.md [Service Persistence]: ./user-guide/Service_Persistence.md [Defining DataService]: ./getting-started.md#defining-a-dataservice [Web Interface Access]: ./getting-started.md#accessing-the-web-interface