docs(README): Updating readme to refer to CHANGES_3.0.0.md #1617
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
jlord
approved these changes
Dec 18, 2017
mbroadst
reviewed
Dec 18, 2017
README.md
Outdated
| @@ -8,6 +8,8 @@ | |||
|
|
|||
| 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. | |||
|
|
|||
| **NOTE: v3.0.0-rc0 was recently released with breaking API changes. You can find a list of changes [here](CHANGES_3.0.0.md).** | |||
There was a problem hiding this comment.
maybe let's call it v3.x was recently released... so we don't have to update this text constantly
Putting a BIG BOLD NOTE at the top of the README that refers to CHANGES_3.0.0.md, so people know about the breaking changes. Fixes NODE-1229
daprahamian
force-pushed
the
NODE-1229
branch
from
d892daf to
f7b6a87
Compare
|
@mbroadst updated |
mbroadst
approved these changes
Dec 18, 2017
This was referenced Mar 8, 2018
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.
Putting a BIG BOLD NOTE at the top of the README that refers to
CHANGES_3.0.0.md, so people know about the breaking changes.
Fixes NODE-1229