It is not clear how to implement the README.md
element of Data Packages.
- A
README.md
can be included indatapackage.zip
but it is not referenced indatapackage.json
. - There is a data package
description
property that appears to be defined similarly to theREADME.md
.
So are the README.md
and the data package description
two ways of achieving the same thing?
If not, what different content is placed in each?
Presenting readme content on a platform
Platforms that support data packages may offer to download:
- a
datapackage.json
file - a
datapackage.zip
- or both
If only a datapackage.json
file is offered, then the README.md
content can be lost.
One solution is to embedded the README.md
content in the datapackage.json
. This is done in datahub.io but strangely the property is called readme
, and not description
.
What should be done?
I think clear guidance is needed on the difference between README.md
and the data package description
property.
I think implementations should ensure that data package consumers get all the information available. Hence, if a datapackage.json
is the only download offered, then the README.md
must be converted to a data package property.
What is not clear is:
- what property should the readme content be written to -
description
or the non-standardreadme
? - what if a
description
property already has content?