diff --git a/README.md b/README.md index dc52e1b..cd7f567 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# FLAME Hub Client +# FLAME Hub Python Client -The FLAME Hub Client is a Python Client which wraps the endpoints of [FLAME Hub](https://github.com/PrivateAIM/hub) +The FLAME Hub Python Client is a client which wraps the endpoints of [FLAME Hub](https://github.com/PrivateAIM/hub) API. This repository is part of the [PrivateAIM](https://privateaim.de/eng/index.html) project. ## Getting started @@ -13,7 +13,7 @@ python -m pip install flame-hub-client ## Quickstart -The FLAME Hub Client offers *get*, *find*, *update*, *create* and *delete* methods for the core, storage and auth +The FLAME Hub Python Client offers *get*, *find*, *update*, *create* and *delete* methods for the core, storage and auth endpoints. It is capable of authenticating against the API using either password or robot authentication. Pick one, provide your credentials and plug them into the class for the service you want to use. Note that the client will automatically reauthenticate if necessary. @@ -104,4 +104,4 @@ assert core_client.get_node(my_node.id) is None ``` Note that not all method types are implemented for each resource. Check out the -[documentation](https://privateaim.github.io/flame-hub-client/) which methods are available. +[documentation](https://privateaim.github.io/hub-python-client/) which methods are available. diff --git a/docs/conf.py b/docs/conf.py index 7ce6233..ce6a0b7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "FLAME Hub Client" +project = "FLAME Hub Python Client" copyright = "2025, Paul Brassel, Maximilian Jugl" author = "Paul Brassel, Maximilian Jugl" version = __version__