-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README #1606
Update README #1606
Conversation
`index` wasn't documented before, I've added in the @param comment to the docs
It's **s** , not **6** in `Node.js`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, thanks Jess! Just a few comments, but overall looks great ✨
README.md
Outdated
|
||
# Installation | ||
|
||
The recommended way to get started using the Node.js 2.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 2.0 driver is by using the `npm` (Node Package Manager) to install the dependency in your project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Node.js 3.0 driver
README.md
Outdated
* kerberos | ||
* node-gyp | ||
* [mongodb-core](https://github.com/mongodb-js/mongodb-core) | ||
* [bson](https://github.com/mongodb-js/bson-ext) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README.md
Outdated
* node-gyp | ||
* [mongodb-core](https://github.com/mongodb-js/mongodb-core) | ||
* [bson](https://github.com/mongodb-js/bson-ext) | ||
* [kerberos](https://github.com/christkv/kerberos) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
README.md
Outdated
|
||
``` | ||
```bash | ||
git clone https://github.com/christkv/kerberos.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
const dbName = 'myproject'; | ||
|
||
// Use connect method to connect to the server | ||
MongoClient.connect(url, function(err, client) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
These changes clean up and update the README with: