From 7ae3ff504d42dba8c313ac190421abaeda29fdb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mose=20M=C3=BCller?= Date: Mon, 19 Aug 2024 15:59:34 +0200 Subject: [PATCH] reference link to license --- README.md | 5 +++-- docs/index.md | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 66f7a11..ed37103 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Version](https://img.shields.io/pypi/v/pydase?style=flat)](https://pypi.org/project/pydase/) [![Python Versions](https://img.shields.io/pypi/pyversions/pydase)](https://pypi.org/project/pydase/) [![Documentation Status](https://readthedocs.org/projects/pydase/badge/?version=stable)](https://pydase.readthedocs.io/en/stable/) -[![License: MIT](https://img.shields.io/github/license/tiqi-group/pydase)](https://github.com/tiqi-group/pydase/blob/main/LICENSE) +[![License: MIT](https://img.shields.io/github/license/tiqi-group/pydase)][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](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. @@ -275,8 +275,9 @@ We welcome contributions! Please see [contributing.md](https://pydase.readthedoc ## License -`pydase` is licensed under the [MIT License](https://github.com/tiqi-group/pydase/blob/main/LICENSE). +`pydase` is licensed under the [MIT License][License]. +[License]: ./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 diff --git a/docs/index.md b/docs/index.md index f19714d..9b81dd3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,6 +4,7 @@ end="" %} +[License]: ./about/license.md [Observer Pattern]: ./dev-guide/Observer_Pattern_Implementation.md [Service Persistence]: ./user-guide/Service_Persistence.md [Defining DataService]: ./getting-started.md#defining-a-dataservice