From 29d7ac8407fe17e745d002351bd63cb930701d6a Mon Sep 17 00:00:00 2001 From: bravo-kernel Date: Fri, 1 Nov 2019 20:40:31 +0100 Subject: [PATCH] docs: update README with Sequelize v6 --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2e75f49..dd6e73e 100644 --- a/README.md +++ b/README.md @@ -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 @@ -43,14 +45,6 @@ schema = schemaManager.generate(userModel, new OpenApi3Strategy()); ``` -## 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: @@ -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).