From 5e4d73b44d8bda77f03f776d5151347ea2e151c8 Mon Sep 17 00:00:00 2001 From: Jens Pelzetter Date: Sun, 12 Jul 2020 12:16:59 +0200 Subject: [PATCH] Some more doc Former-commit-id: df9b53680c1230bc06e1c091845875e19fd77bb4 --- ccm-apiclient-commons/README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/ccm-apiclient-commons/README.md b/ccm-apiclient-commons/README.md index d8c91aad4..b28c137aa 100644 --- a/ccm-apiclient-commons/README.md +++ b/ccm-apiclient-commons/README.md @@ -1,5 +1,17 @@ LibreCCM API Client Commons =========================== -This module provides basic classes for building clients for the RESTful APIs -provided by modules of LibreCCM. Details can be found in the documentation. \ No newline at end of file +This module provides several usaable parts of building clients for +specific endpoints of the LibreCCM RESTful API. + +The `entities` module provides several entities used by various endpoints +of the RESTful API of LibreCCM. + +The module also provides an HTTP client specially tailored for +the RESTful API of LibreCCM. The client is provided in several implementations: +For browsers, for node.js and an isomorphic implementation. In most cases +you will want to use the isomorphic implementation. + +For most use cases it is recommanded to use the specific client APIs provided +by the LibreCCM modules which provided a more high-level interface to the RESTful +API of LibreCCM.