@release-notes/schema/README.md

JSON Schema definitions of the release-notes specification - an easy to use, human readable and machine processable schema for release notes.

# Release Notes Schema

[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-schema)
[![NPM Package](https://img.shields.io/npm/v/@release-notes/schema.svg)](https://www.npmjs.com/package/@release-notes/schema)
[![MIT license](https://img.shields.io/github/license/release-notes/release-notes-schema.svg)](LICENSE)

# About

The goal of this repository is to implement [JSON Schema Definitions](https://trac.tools.ietf.org/html/draft-wright-json-schema-validation-01)
of the [Release Notes Specification](https://github.com/release-notes/release-notes-spec).

The following schemas are defined:

* [ReleaseNotes](definitions/release-notes.json)
* [Release](definitions/release.json)
* [ModificationList](definitions/modification-list.json)
* [Modification](definitions/modification.json)
* [TagList](definitions/tag-list.json)
* [Tag](definitions/tag.json)

## Installation

`$ npm i -S @release-notes/schema`

## Usage

```js
const ReleaseNotesSchema = require('@release-notes/schema');

console.info(
  'Required fields of release notes: %s',
  ReleaseNotesSchema.ReleaseNotes.required.join(', ')
);
```

## Project Repositories

The Release Notes project consists of the following repositories:
   
- [Release Notes Hub](https://github.com/release-notes/release-notes-hub)
- [Release Notes CLI Tool](https://github.com/release-notes/release-notes-cli)
- [Release Notes Node.js lib](https://github.com/release-notes/release-notes-node)
- [Release Notes Specification](https://github.com/release-notes/release-notes-spec)
- [Release Notes JSON-Schema Definitions](https://github.com/release-notes/release-notes-schema)

---

### LICENSE

The files in this archive are released under MIT license.
You can find a copy of this license in [LICENSE](LICENSE).