libreccm/ccm-apiclient-commons/README.md

18 lines
730 B
Markdown

LibreCCM API Client Commons
===========================
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.