Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): update README to be more like main (#14626)
* docs(readme): update README to be more like main * fix(readme): update logo
- Loading branch information
Showing
2 changed files
with
70 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,65 @@ | ||
<p align="center"> | ||
<img src="docs/images/logo-small.png" width="100" /> | ||
<h1 align="center">Sequelize</h1> | ||
<p style="text-align: center;"> | ||
<img src="logo.svg" width="100" alt="Sequelize logo" /> | ||
<h1 align="center"><a href="https://sequelize.org">Sequelize</a></h1> | ||
</p> | ||
|
||
[![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), [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server), and [Snowflake](https://www.snowflake.com/). It features solid transaction support, relations, eager and lazy loading, read replication and more. | ||
|
||
Sequelize follows [Semantic Versioning](http://semver.org) and supports Node v10 and above. | ||
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! 😃 | ||
|
||
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). | ||
## :computer: Getting Started | ||
|
||
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. | ||
Ready to start using Sequelize? Head to [sequelize.org](https://sequelize.org) to begin! | ||
|
||
### v6 Release | ||
- [Our Getting Started guide for Sequelize 6 (stable)](https://sequelize.org/docs/v6/getting-started) | ||
|
||
You can find the detailed changelog [here](https://github.com/sequelize/sequelize/blob/main/docs/manual/other-topics/upgrade-to-v6.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 | ||
|
||
```sh | ||
$ npm i sequelize # This will install v6 | ||
|
||
# And one of the following: | ||
$ npm i pg pg-hstore # Postgres | ||
$ npm i mysql2 | ||
$ npm i mariadb | ||
$ npm i sqlite3 | ||
$ npm i tedious # Microsoft SQL Server | ||
$ npm i ibm_db #DB2 | ||
``` | ||
## :pencil: Major version changelog | ||
|
||
## Documentation | ||
Please find upgrade information to major versions here: | ||
|
||
- [v6 Documentation](https://sequelize.org/master) | ||
- [v5/v4/v3 Documentation](https://sequelize.org) | ||
- [Contributing](https://github.com/sequelize/sequelize/blob/main/CONTRIBUTING.md) | ||
- [Upgrade from v5 to v6](https://sequelize.org/docs/v6/other-topics/upgrade-to-v6) | ||
|
||
## 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 | ||
|
||
- [Documentation](https://sequelize.org) | ||
- [Databases Compatibility Table](https://sequelize.org/releases/) | ||
- [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) | ||
- [With TypeScript](https://sequelize.org/docs/v6/other-topics/typescript) | ||
- [Enhanced TypeScript with decorators](https://github.com/RobinBuschmann/sequelize-typescript) | ||
- [For GraphQL](https://github.com/mickhansen/graphql-sequelize) | ||
- [For CockroachDB](https://github.com/cockroachdb/sequelize-cockroachdb) | ||
- [Plugins](https://sequelize.org/master/manual/resources.html) | ||
- [Awesome Sequelize](https://sequelize.org/docs/v6/other-topics/resources/) | ||
- [For YugabyteDB](https://github.com/yugabyte/sequelize-yugabytedb) | ||
|
||
### Translations | ||
### :speech_balloon: Translations | ||
|
||
- [English](https://sequelize.org) (Official) | ||
- [中文文档](https://github.com/demopark/sequelize-docs-Zh-CN) (Unofficial) | ||
|
||
- [English](https://sequelize.org/master) (OFFICIAL) | ||
- [中文文档](https://github.com/demopark/sequelize-docs-Zh-CN) (UNOFFICIAL) | ||
## :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. |