Skip to content
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

Merged
merged 6 commits into from
Dec 8, 2017
Merged

Update README #1606

merged 6 commits into from
Dec 8, 2017

Conversation

jlord
Copy link
Contributor

@jlord jlord commented Dec 6, 2017

These changes clean up and update the README with:

@jlord jlord requested review from daprahamian and mbroadst December 6, 2017 20:31
Copy link
Member

@mbroadst mbroadst left a 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.
Copy link
Member

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)
Copy link
Member

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)
Copy link
Member

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
Copy link
Member

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) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

@daprahamian daprahamian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jlord jlord merged commit c125d19 into 3.0.0 Dec 8, 2017
@jlord jlord deleted the readme branch December 8, 2017 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants