Skip to content

Commit

Permalink
docs: update README with Sequelize v6
Browse files Browse the repository at this point in the history
  • Loading branch information
bravo-kernel committed Nov 1, 2019
1 parent 0b16cc9 commit 29d7ac8
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Expand Up @@ -9,18 +9,20 @@

# sequelize-to-json-schemas

Convert Sequelize models into various JSON Schema variants (using the Strategy Pattern).

## Supported Schemas
Convert Sequelize models into these JSON Schema variants (using the Strategy Pattern):

- JSON Schema Draft-07 - [sample output](examples/json-schema-v7.md)
- OpenAPI 3.0 - [sample output](examples/openapi-v3.md)

> More welcome, [very simple, inspiration found here](https://github.com/alt3/sequelize-to-json-schemas/tree/master/lib/strategies)
## Main Goals

## Framework Integrations
- understandable code, highly maintainable
- support for Sequelize versions 4, 5, 6 and future
- valid schemas (enforced by the [ajv](https://github.com/epoberezkin/ajv) and [Swagger Parser](https://github.com/APIDevTools/swagger-parser) validators)
- JsonSchemaManager for single (rock solid) core functionality shared between all strategies
- StrategyInterface for simplified implementation of new schema variants

- [Feathers](https://github.com/alt3/sequelize-to-json-schemas/issues/17)
> Feel free to PR strategies for missing schemas
## Installation

Expand All @@ -43,14 +45,6 @@ schema = schemaManager.generate(userModel, new OpenApi3Strategy());
```
<!-- prettier-ignore-end -->

## Main Goals

- understandable code, highly maintainable
- support for Sequelize versions 4, 5 and beyond
- valid schemas (enforced by the [ajv](https://github.com/epoberezkin/ajv) and [Swagger Parser](https://github.com/APIDevTools/swagger-parser) validators)
- JsonSchemaManager for single (rock solid) core functionality shared between all strategies
- StrategyInterface for simplified implementation of new schema variants

## Configuration Options

To configure global options use the JsonSchemaManager initialization:
Expand Down Expand Up @@ -135,6 +129,10 @@ module.exports = sequelize => {
};
```

## Framework Integrations

- [Feathers](https://github.com/alt3/sequelize-to-json-schemas/issues/17)

## License

This project is released under [MIT LICENSE](LICENSE.txt).
Expand Down

0 comments on commit 29d7ac8

Please sign in to comment.