docs(readme): make it easier for newcomers #10676
Conversation
README.md
Outdated
| @@ -16,7 +16,9 @@ | |||
|
|
|||
| Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more. | |||
|
|
|||
| Sequelize follows [SEMVER](http://semver.org). Supports Node v6 and above to use ES6 features. | |||
| Sequelize follows [SEMVER](http://semver.org). Supports Node v6 and above to use ES6 features. [Official TypeScript typings are also included](http://docs.sequelizejs.com/manual/typescript). | |||
There was a problem hiding this comment.
This conflicts a little with my PR: #10677
There was a problem hiding this comment.
@SimonSchick oh, nice PR 😬 I've retracted this part of mine then.
But, I think you should update your PR with some mention to TypeScript more closer to the beginning of the README. Supporting TypeScript is a huge plus that IMO should be mentioned ASAP. Newcomers that take a glance at the README should see that TS is supported 😬 What do you think?
Codecov Report
@@ Coverage Diff @@
## master #10676 +/- ##
==========================================
- Coverage 96.2% 95.38% -0.82%
==========================================
Files 93 90 -3
Lines 9011 8800 -211
==========================================
- Hits 8669 8394 -275
- Misses 342 406 +64
Continue to review full report at Codecov.
|
|
🎉 This PR is included in version 5.2.9 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description of change
Adding a few more things to the README to give important information more quickly to newcomers. I think the README should be a place where a quick glance should pass a lot of information, especially for people who don't know the project.