Skip to content

Commit ccb3aa8

Browse files
committed
minor: clarify that legacy is not production ready
1 parent 4305cbf commit ccb3aa8

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

README.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,25 @@ Welcome to the MongoDB C++ Driver!
33

44
Use this branch if:
55

6-
- You have existing code that used the driver from the server source
7-
and want it to continue working without modification.
6+
- You need a production ready release of the C++ driver that is not under active development.
7+
- You have existing code that used the driver from the server source and want it to continue working without modification.
88

99
Switch to the legacy branch if:
1010

11-
- You are using MongoDB's C++ driver for the first time.
12-
- You had been using 26compat (or the driver inside of the server source) and
13-
want to benefit from incremental improvements but have the same overall API.
11+
- You are using MongoDB's C++ driver for the first time and do not mind the driver being actively worked on.
12+
- 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.
1413

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.
14+
> **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.
2215
2316
## Repository Overview
2417

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 |
18+
| Branch | Stability | Development | Purpose |
19+
| -------- | ----------| ----------------- | ----------------------------------------------------- |
20+
| master | Unstable | Planning | New C++ driver (work in progress) |
21+
| legacy | Unstable | Active | Existing C++ driver with non-compatible improvements |
22+
| 26compat | Stable | Maintenance Only | Drop in replacement for users of existing C++ driver |
23+
24+
> **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.
3025
3126
## Components
3227

0 commit comments

Comments
 (0)