Skip to content

Commit 19acad1

Browse files
committed
minor: improve README for 26compat branch release
1 parent 40d8d4a commit 19acad1

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
1-
# MongoDB Legacy C++ Driver [![Build Status](http://img.shields.io/travis/mongodb/mongo-cxx-driver/legacy.svg)](https://travis-ci.org/mongodb/mongo-cxx-driver)
2-
Welcome to the MongoDB Legacy C++ Driver!
1+
# MongoDB C++ Driver [![Build Status](http://img.shields.io/travis/mongodb/mongo-cxx-driver/legacy.svg)](https://travis-ci.org/mongodb/mongo-cxx-driver)
2+
Welcome to the MongoDB C++ Driver!
33

4-
This driver is an extraction of the "Server C++ Driver" from the primary
5-
MongoDB sources. You should prefer using this to building the driver
6-
from the server sources if at all possible. Please note that as of
7-
MongoDB 2.6.0-rc1, it is no longer possible to build the driver from
8-
the server sources: this repo is the only approved source for driver builds.
4+
Use this branch if:
5+
6+
- You are using MongoDB's C++ driver for the first time.
7+
- You had been using 26compat (or the driver inside of the server source) and
8+
want to benefit from incremental improvements but have the same overall API.
9+
10+
Switch to the 26compat branch if:
11+
12+
- You have existing code that used the driver from the server source
13+
and want it to continue working without modification.
14+
15+
**Please Note:** As of MongoDB 2.6.0-rc1, it is no longer possible to build the
16+
driver from the server sources: this repository is the only approved source for
17+
driver builds.
18+
19+
The master branch will contain future development work on a new driver with a
20+
completely new API and implementation. It is a work in progress and currently
21+
should not be used.
22+
23+
## Repository Overview
24+
25+
| Branch | Development | Purpose |
26+
| -------- | ------------------ | ----------------------------------------------------- |
27+
| master | Planning | New C++ driver (work in progress) |
28+
| legacy | Active | Existing C++ driver with non-compatible improvements |
29+
| 26compat | Maintenance Only | Drop in replacement for users of existing C++ driver |
930

1031
## Components
1132

@@ -16,14 +37,15 @@ the server sources: this repo is the only approved source for driver builds.
1637

1738
See http://docs.mongodb.org/ecosystem/tutorial/download-and-compile-cpp-driver/
1839

19-
The above instructions (currently) assume that you are building from the server
20-
repository, but the will work with this repository as described.
40+
## Bugs and Issues
41+
42+
See http://jira.mongodb.org/browse/CXX
2143

2244
## Notes
2345

2446
Use of the shared library is experimental on windows and is currently
25-
discouraged. This is primarily due to the complexity of ensuring a matching
26-
implementation of STL types between library and consumer code. This problem
47+
discouraged. This is primarily due to the complexity of ensuring a matching
48+
implementation of STL types between library and consumer code. This problem
2749
is unique to windows, as the consistent use of system libraries largely
2850
mitigates this danger.
2951

0 commit comments

Comments
 (0)