RDFJS Library README template

Placeholder: Library-related badges go here

This document is a README template for RDFJS-related projects. It is a minimal template that lists all recommended elements and sections, with some example placeholder contents.

The structure of this README can be changed to meet the needs of the library. The following elements SHOULD be present (optionally behind links to other documents):

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.

Placeholder: A high-level description of this library

Installation

This tool can be installed via either npm or yarn:

$ npm install my-library

$ yarn add my-library

This tool can be imported into your project as follows:

import {MyTool} from "my-library";

const MyTool = require("my-library").MyTool;

Usage

Placeholder: A high-level description on the usage and available functionality

Main Feature 1

Placeholder: Description of a feature

// Some example code

Configuration

Placeholder: The available config options for this library, e.g. constructor params

Optionally, the following parameters can be set in the MyTool constructor:

dataFactory: A custom RDFJS DataFactory to construct terms and triples. (Default: require('@rdfjs/data-model'))
baseIRI: An initial default base IRI. (Default: '')

new MyTool({
  dataFactory: require('@rdfjs/data-model'),
  baseIRI: 'http://example.org/',
});

Specification Compliance

Placeholder: If applicable, mention the compliance with respect to any (W3C) specification, including RDFJS interfaces

License

This software is written by Someone.

This code is released under the MIT license.