From 6eb0186ddfd3e088ee072d4cd57dd59c9a3a2b7e Mon Sep 17 00:00:00 2001 From: fncolon Date: Thu, 13 Jan 2022 14:57:18 +0700 Subject: [PATCH] docs: introduce new version of sequelize README (#13946) * docs: introduce new version of sequelize README - Yarn installation - Badges - Emoji (will fit with incoming docusaurus PR) * fix: link to backers section Co-authored-by: Sascha Depold --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a1a64832df7e..e8ca2da7bc6c 100644 --- a/README.md +++ b/README.md @@ -6,63 +6,79 @@ [![npm version](https://badgen.net/npm/v/sequelize)](https://www.npmjs.com/package/sequelize) [![Build Status](https://github.com/sequelize/sequelize/workflows/CI/badge.svg)](https://github.com/sequelize/sequelize/actions?query=workflow%3ACI) [![npm downloads](https://badgen.net/npm/dm/sequelize)](https://www.npmjs.com/package/sequelize) +[![contributors](https://img.shields.io/github/contributors/sequelize/sequelize)](https://github.com/sequelize/sequelize/graphs/contributors) +[![Open Collective](https://img.shields.io/opencollective/backers/sequelize)](https://opencollective.com/sequelize#section-contributors) [![sponsor](https://img.shields.io/opencollective/all/sequelize?label=sponsors)](https://opencollective.com/sequelize) [![Merged PRs](https://badgen.net/github/merged-prs/sequelize/sequelize)](https://github.com/sequelize/sequelize) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Sequelize is a promise-based [Node.js](https://nodejs.org/en/about/) [ORM tool](https://en.wikipedia.org/wiki/Object-relational_mapping) for [Postgres](https://en.wikipedia.org/wiki/PostgreSQL), [MySQL](https://en.wikipedia.org/wiki/MySQL), [MariaDB](https://en.wikipedia.org/wiki/MariaDB), [SQLite](https://en.wikipedia.org/wiki/SQLite), [DB2](https://en.wikipedia.org/wiki/IBM_Db2_Family) and [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server). It features solid transaction support, relations, eager and lazy loading, read replication and more. +Sequelize is an easy-to-use and promise-based [Node.js](https://nodejs.org/en/about/) [ORM tool](https://en.wikipedia.org/wiki/Object-relational_mapping) for [Postgres](https://en.wikipedia.org/wiki/PostgreSQL), [MySQL](https://en.wikipedia.org/wiki/MySQL), [MariaDB](https://en.wikipedia.org/wiki/MariaDB), [SQLite](https://en.wikipedia.org/wiki/SQLite), [DB2](https://en.wikipedia.org/wiki/IBM_Db2_Family) and [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server). It features solid transaction support, relations, eager and lazy loading, read replication and more. Sequelize follows [Semantic Versioning](http://semver.org) and the [official Node.js LTS schedule](https://nodejs.org/en/about/releases/). Version 7 of Sequelize officially supports the Node.js versions `^12.22.0`, `^14.17,0`, `^16.0.0`. Other version might be working as well. New to Sequelize? Take a look at the [Tutorials and Guides](https://sequelize.org/master). You might also be interested in the [API Reference](https://sequelize.org/master/identifiers). -Would you like to contribute? Read [our contribution guidelines](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md) to know more. There are many ways to help. +Would you like to contribute? Read [our contribution guidelines](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md) to know more. There are many ways to help! 😃 -### Major version changelog +### :pencil: Major version changelog Please find upgrade information to major versions here: - [Upgrade from v5 to v6](https://github.com/sequelize/sequelize/blob/main/docs/manual/other-topics/upgrade-to-v6.md) - [Upgrade from v6 to v7](https://github.com/sequelize/sequelize/blob/main/docs/manual/other-topics/upgrade-to-v7.md) -## Supporting the project +## :money_with_wings: Supporting the project Do you like Sequelize and would like to give back to the engineering team behind it? We have recently created an [OpenCollective based money pool](https://opencollective.com/sequelize) which is shared amongst all core maintainers based on their contributions. Every support is wholeheartedly welcome. ❤️ -## Installation +## :computer: Installation -```bash +```sh +# using npm npm i sequelize # This will install latest version of Sequelize +# using yarn +yarn add sequelize +``` +```sh # Libraries used for supported dialects are : +# using npm npm i pg pg-hstore # PostgreSQL npm i mysql2 # MySQL npm i mariadb # MariaDB npm i sqlite3 # SQLite npm i tedious # Microsoft SQL Server npm i ibm_db # DB2 +# using yarn +yarn add pg pg-hstore # PostgreSQL +yarn add mysql2 # MySQL +yarn add mariadb # MariaDB +yarn add sqlite3 # SQLite +yarn add tedious # Microsoft SQL Server +yarn add ibm_db # DB2 ``` -## Documentation +## :book: Documentation - [Latest Version Documentation (v7)](https://sequelize.org/v7) - [All Documentation Versions](https://sequelize.org) - [Contributing](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md) -## Responsible disclosure +## :warning: Responsible disclosure If you have security issues to report, please refer to our [Responsible Disclosure Policy](https://github.com/sequelize/sequelize/blob/main/SECURITY.md) for more details. -## Resources +## :book: Resources - [Changelog](https://github.com/sequelize/sequelize/releases) - [Discussions](https://github.com/sequelize/sequelize/discussions) - [Slack Inviter](http://sequelize-slack.herokuapp.com/) - [Stack Overflow](https://stackoverflow.com/questions/tagged/sequelize.js) -### Tools +### :wrench: Tools - [CLI](https://github.com/sequelize/cli) - [With TypeScript](https://sequelize.org/master/manual/typescript.html) @@ -72,7 +88,7 @@ If you have security issues to report, please refer to our [Responsible Disclosu - [Plugins](https://sequelize.org/master/manual/resources.html) - [For YugabyteDB](https://github.com/yugabyte/sequelize-yugabytedb) -### Translations +### :speech_balloon: Translations - [English](https://sequelize.org/master) (OFFICIAL) - [中文文档](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL)