# @release-notes/node

> An easy to use, human readable and machine processable schema for release notes.

Latest version **0.3.0** (published 2017-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @release-notes/node
pnpm add @release-notes/node
yarn add @release-notes/node
bun add @release-notes/node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2017-12-17 |
| First published | 2017-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Alrik Zachert |
| Maintainers | a-z |
| Keywords | release notes, release-notes, releasenotes, release, notes, changelog |

## Links

- npm: https://www.npmjs.com/package/@release-notes/node
- Repository: https://github.com/release-notes/release-notes-node
- Homepage: https://release-notes.com
- Issues: https://github.com/release-notes/release-notes-node/issues
- npm.io page: https://npm.io/package/@release-notes/node

## Dependencies (3)

- [ajv](https://npm.io/package/ajv.md) ^5.5.2
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.10.0
- [@release-notes/schema](https://npm.io/package/@release-notes/schema.md) ^0.2.0

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.3.0 (latest) — 2017-12-17
- 0.2.0 — 2017-08-06
- 0.1.1 — 2017-07-16
- 0.1.0 — 2017-07-07

## README

# Release Notes Node

[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-node)
[![NPM Package](https://img.shields.io/npm/v/@release-notes/node.svg)](https://www.npmjs.com/package/@release-notes/node)
[![Build Status](https://travis-ci.org/release-notes/release-notes-node.svg?branch=master)](https://travis-ci.org/release-notes/release-notes-node)
[![MIT license](https://img.shields.io/github/license/release-notes/release-notes-node.svg)](LICENSE)

**Title**   | Release Notes Node
:-----------|:---------------------------
**Specification** | [Release Notes Draft 0.2.0](https://github.com/release-notes/release-notes-spec/blob/0.2.0/README.md)
**Author**  | [Alrik Zachert](https://github.com/alrik)
**License** | MIT

The goal of this repository is to provide a reference implementation
of the [Release Notes Specification](https://github.com/release-notes/release-notes-spec).

## Installation

`$ npm i @release-notes/node`

## Load A Release Notes File

```js
const ReleaseNotesLoader = require('@release-notes/node/lib/ReleaseNotesLoader');
const loader = new ReleaseNotesLoader();

loader.readReleaseNotesFile('./release-notes.yml', (err, releaseNotes) => {
  if (err) {
    if (err.isValidationError) {
      return void console.error(
        'Could not load release notes. Validation failed: ',
        err.validationErrors
      );
    }

    return void console.error(
      'Could not load release-notes.yml',
      err
    );
  }

  console.info(
    `Successfully loaded release notes ${releaseNotes.title}`
  );
});
```

---

### LICENSE

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

---
_Source: https://npm.io/package/@release-notes/node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._