chore: format readme and add note about 4.0 beta #2729
Merged
Conversation
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
kmahar
reviewed
Feb 3, 2021
README.md
Outdated
| [](https://gitter.im/mongodb/node-mongodb-native?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) | ||
|
|
||
| # Description | ||
| [](https://nodei.co/npm/mongodb/) | ||
|
|
||
| The official [MongoDB](https://www.mongodb.com/) driver for Node.js. Provides a high-level API on top of [mongodb-core](https://www.npmjs.com/package/mongodb-core) that is meant for end users. |
There was a problem hiding this comment.
mention of core seems irrelevant now that we merged the repos, want to take that out?
README.md
Outdated
| * [bson](https://github.com/mongodb/js-bson) | ||
| * [kerberos](https://github.com/mongodb-js/kerberos) | ||
| * [node-gyp](https://github.com/nodejs/node-gyp) | ||
| - [mongodb-core](https://github.com/mongodb-js/mongodb-core) |
There was a problem hiding this comment.
also outdated I think? this seems maybe a bit oudated in general?
kmahar
approved these changes
Feb 3, 2021
durran
requested changes
Feb 4, 2021
README.md
Outdated
| @@ -196,7 +197,7 @@ const dbName = 'myproject'; | |||
| // Use connect method to connect to the server | |||
| MongoClient.connect(url, function(err, client) { | |||
There was a problem hiding this comment.
Would we want to change the example to use the MongoClient constructor instead? (Just to get people in the habit of doing that since if they want to listen to events from the very beginning, like SDAM events, they will need to register the handlers before connecting)
emadum
reviewed
Feb 4, 2021
README.md
Outdated
|
|
||
| # Installation | ||
| ## Installation | ||
|
|
||
| The recommended way to get started using the Node.js 3.0 driver is by using the `npm` (Node Package Manager) to install the dependency in your project. |
There was a problem hiding this comment.
Suggested change
| The recommended way to get started using the Node.js 3.0 driver is by using the `npm` (Node Package Manager) to install the dependency in your project. | |
| The recommended way to get started using the Node.js driver is by using `npm` (Node Package Manager) to install the dependency in your project. |
README.md
Outdated
Comment on lines
7
to
8
| **Looking for the latest?** We're working on the next major version of the driver now in beta. | ||
| Check out our [beta version 4.0 here](https://github.com/mongodb/node-mongodb-native/tree/4.0). |
There was a problem hiding this comment.
Suggested change
| **Looking for the latest?** We're working on the next major version of the driver now in beta. | |
| Check out our [beta version 4.0 here](https://github.com/mongodb/node-mongodb-native/tree/4.0). | |
| ### Version 4.0 | |
| **Looking for the latest?** We're working on the next major version of the driver, now in beta. | |
| Check out our [beta version 4.0 here](https://github.com/mongodb/node-mongodb-native/tree/4.0), which includes a full migration of the driver to TypeScript. |
I think adding a heading and a mention of TypeScript would help draw attention to the beta.
This was referenced Mar 16, 2021
This was referenced Mar 17, 2021
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a small note at the top of the readme about 4.0 beta, let me know if we want to make it more noticable somehow
(Also ran prettier on the readme which makes the code examples match our code style)