Skip to content

Commit 6067bc9

Browse files
committed
CXX-765 Update readme to reflect stable C++11 driver
1 parent 3fe5139 commit 6067bc9

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
11
# MongoDB C++ Driver [![Build Status](https://travis-ci.org/mongodb/mongo-cxx-driver.svg?branch=26compat)](https://travis-ci.org/mongodb/mongo-cxx-driver)
22
Welcome to the MongoDB C++ Driver!
33

4-
Use this branch if:
4+
Please see our [wiki page](https://github.com/mongodb/mongo-cxx-driver/wiki/Download-and-Compile-the-Legacy-Driver) for information about building, testing, and using the driver.
55

6-
- You have existing code that used the driver from the server source and want it to continue working without modification.
6+
Version [legacy-0.0-26compat-2.6.12](https://github.com/mongodb/mongo-cxx-driver/tree/legacy-0.0-26compat-2.6.11) of the
7+
C++ legacy driver has been released. Please report any bugs or issues in the C++
8+
[JIRA project](http://jira.mongodb.org/browse/CXX).
79

8-
Switch to the legacy branch if:
9-
10-
- You are using MongoDB's C++ driver for the first time.
11-
- You had been using 26compat (or the driver inside of the server source) and want to benefit from incremental improvements while having the same overall API.
10+
Use this branch only if you have existing code that used the driver
11+
from the server source and want it to continue working without
12+
modification. Switch to the "legacy" branch if you had previosuly been
13+
using 26compat (or the driver inside of the server source) and want to
14+
benefit from incremental improvements while having the same overall
15+
API. Switch to the "master" branch if you are using MongoDB's C++
16+
driver for the first time.
1217

1318
> **Note:** As of MongoDB 2.6.0-rc1, it is no longer possible to build the driver from the server sources: this repository is the only approved source for driver builds.
1419
1520
## Repository Overview
1621

1722
| Branch | Stability | Development | Purpose |
1823
| -------- | ------------| ----------------- | ----------------------------------------------------- |
19-
| master | Unstable | Planning | New C++11 driver (work in progress) |
24+
| master | Stable | Stable Evolution | New C++11 driver |
2025
| legacy | Stable | Stable Evolution | Primary stable C++ driver release |
2126
| 26compat | Stable | Maintenance Only | Drop in replacement for users of existing 2.6 era C++ driver |
2227

23-
> **WARNING:** The master branch will contain future development work on a new driver with a completely new API and implementation. It is a work in progress and currently should not be used.
24-
2528
## Components
2629

2730
- `libmongoclient.[so|dylib|dll]` - The shared mongoclient library (but see notes)

0 commit comments

Comments
 (0)