Improved logo.

INESCTEC · Feb 23, 2024 · 7decafa · 7decafa
1 parent 3f85c0e
commit 7decafa
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/source/_static/logo.png b/docs/source/_static/logo.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,9 +3,23 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+.. image:: _static/logo.png
+   :width: 572
+
 Welcome to TSG Client's documentation!
 ======================================
 
+TSG Client is a Python library for interacting with the TNO Security Gateway (TSG). It is current version, it is a simple REST API client that interacts with TSG Core Connector APIs and TSG OpenAPI Data APP. It provides a simple and easy-to-use interface for tasks such as:
+
+ - Connecting to a TSG core container (via API KEY)
+ - Retrieving connector self-descriptions
+ - Parsing / filtering connector catalogs and artifacts, retrieved from self-descriptions
+ - Requesting and consuming data artifacts (via dataspace)
+ - Queries to the dataspace Metadata Broker to list registered connectors and respective self-descriptions
+ - Perform requests via OpenAPI Data APP
+
+This document provides detailed instructions for setting up the INESC TEC Client for TNO Security Gateway (TSG-Client) environment. Please follow these steps carefully to ensure successful configuration and deployment.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: