Skip to content

Conversation

@tpluscode
Copy link
Contributor

@tpluscode tpluscode commented May 7, 2021

To improve the usability of RDFJS tools,
we recommend all listed libraries to have the following elements in their documentation (README or linked).
Please select all elements that apply for your library:

  • General description: High-level description of tool and available features.
  • Installation: How to install and import into project.
  • Usage: Describing the main features with code examples.
  • Configuration: The available config options for this tool, e.g. constructor params.
  • Specification Compliance: Mention the compliance with respect to any (W3C) specification, including RDFJS interfaces.
  • License: The license under which the library is available.

Feel free to reuse our README template for this.

@l00mi l00mi merged commit ffc5c56 into rdfjs:master May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants