From d15fa68b3b4703ee172d706ea39b148e9dd8bd47 Mon Sep 17 00:00:00 2001 From: Volker Krause Date: Mon, 4 Jan 2021 17:06:49 +0100 Subject: [PATCH] Document attribution information --- readme.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/readme.md b/readme.md index 546f727..2190fa1 100644 --- a/readme.md +++ b/readme.md @@ -89,6 +89,24 @@ The following properties are defined for each coverage category: Both fields should be provided. +### Attribution Information + +License and copyright attribution data for endpoints providing results under an Open Data license. This generally follows the [Data Packages format](https://dataprotocols.org/data-packages/). + +```js +{ + "attribution": { + "name": "© Helsinki Region Transport", + "license": "CC-BY-4.0", + "homepage": "https://www.hsl.fi/" + } +} +``` + +Properties: +* `license`: An [Open Definition license ID](https://licenses.opendefinition.org/) or a [SPDX license id](https://spdx.org/licenses/). +* `name` and `homepage`: The entity to attribute for licenses requiring this. + ### Protocol Specific Options #### Hafas mgate.exe