Skip to content
This repository was archived by the owner on Oct 18, 2021. It is now read-only.

Commit 20c1ffc

Browse files
committed
change README to reflect that the driver works on 1.x
1 parent 69e9926 commit 20c1ffc

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,39 @@
1-
[![Travis](https://travis-ci.org/mongodb-labs/mongo-rust-driver-prototype.svg)](https://travis-ci.org/mongodb-labs/mongo-rust-driver-prototype)
2-
[![Crates.io](https://img.shields.io/crates/v/mongodb.svg)](https://crates.io/crates/mongodb)
3-
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
1+
[![Travis](https://travis-ci.org/mongodb-labs/mongo-rust-driver-prototype.svg)](https://travis-ci.org/mongodb-labs/mongo-rust-driver-prototype)[![Crates.io](https://img.shields.io/crates/v/mongodb.svg)](https://crates.io/crates/mongodb)[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
42

53
MongoDB Rust Driver Prototype
64
=============================
75

8-
This branch contains active development on a new driver written for Rust 1.0.
6+
This branch contains active development on a new driver written for Rust 1.x.
97

108
The API and implementation are currently subject to change at any time. You must not use this driver in production as it is still under development and is in no way supported by MongoDB Inc. We absolutely encourage you to experiment with it and provide us feedback on the API, design, and implementation. Bug reports and suggestions for improvements are welcomed, as are pull requests.
119

12-
## Installation
10+
Installation
11+
------------
1312

1413
#### Dependencies
15-
- [Rust 1.0 with Cargo](http://rust-lang.org)
14+
15+
- [Rust 1.x with Cargo](http://rust-lang.org)
1616

1717
#### Importing
18-
The 1.0 driver is available on crates.io. To use the MongoDB driver in your code, add the bson and mongodb packages to your ```Cargo.toml```:
18+
19+
The 1.0 driver is available on crates.io. To use the MongoDB driver in your code, add the bson and mongodb packages to your `Cargo.toml`:
20+
1921
```
2022
[dependencies]
21-
bson = "0.1.3"
23+
bson = "0.1.4"
2224
mongodb = "0.1.0"
2325
```
2426

2527
Then, import the bson and driver libraries within your code.
28+
2629
```rust
2730
#[macro_use(bson, doc)]
2831
extern crate bson;
2932
extern crate mongodb;
3033
```
3134

32-
## Examples
35+
Examples
36+
--------
3337

3438
Here's a basic example of driver usage:
3539

@@ -69,5 +73,7 @@ fn main() {
6973
}
7074
```
7175

72-
## Documentation
73-
Documentation is built using Cargo. The latest documentation can be found [here](https://mongodb-labs.github.io/mongo-rust-driver-prototype/mongodb). Generated documentation using ```cargo doc``` can be found under the _target/doc/_ folder.
76+
Documentation
77+
-------------
78+
79+
Documentation is built using Cargo. The latest documentation can be found [here](https://mongodb-labs.github.io/mongo-rust-driver-prototype/mongodb). Generated documentation using `cargo doc` can be found under the *target/doc/* folder.

0 commit comments

Comments
 (0)