README

This is the official PHP library for connecting and communicating with the REST API to the national catalog of the Swiss digital school library. It handles authentication, reading descriptions, searching, etc.

Installation

Install using Composer. Add the following to your composer.json:

{
  "require": {
    "educach/dsb-client": "dev-master"
  }
}

Documentation

• Documentation for the client library can be found here.
• Documentation for the REST API can be found here.
• Documentation for the LOM-CH standard (v1.2) can be found here: German, French, Italian

Contributing

Contributions are more than welcome. There's still lots of work to be done before we reach version 1.0.0.

General guide lines:

• Respect the PSR-2 standard (coding style guide).
• Respect the PSR-4 standard (autoloading).
• Write unit tests. Our aim is to remain at +90% coverage.

Check the existing interfaces and try to remain consistent in regards to method naming, parameters, usage, etc.