Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.5 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.5 KB

REST HAL Sequelize

Build Status Coverage Status

This project provide a mapping from Sequelize models into a REST API that use the JSON Hypertext Application Language Media Type.

Installation

rest-hal-sequelize runs on supported versions of Node.js and is available as an NPM package.

Previously this package supported Node.js from version 6 onwards. That is
not the case anymore.

You can install rest-hal-sequelize in your project's directory as usual:

npm install @yeiniel/rest-hal-sequelize --save

Reference Documentation

Reference documentation for this project can be generated from the inline comments on source code using the Typedoc documentation generator. The following command ease the task:

npm run typedoc

Typescript Support

This package is written in [Typescript][typescript] and it provide a declaration file for its content so you can use it on Typescript projects without problems.

Licensing

The code in this project is licensed under MIT license.