Merged pull request #137

Author: derickr

CONTRIBUTING.md

@@ -1,7 +1,7 @@
-# Contributing to pecl/MongoDB
+# Contributing to the PHP Driver for MongoDB
 
 
-## Building from VCS
+## Building from VCS (GitHub)
 
 Developers who would like to contribute to the driver will need to build it from VCS
 like so:
@@ -15,11 +15,6 @@ $ ./configure --enable-developer-flags
 $ make -j8 all
 ```
 
-Be aware that we are submoduling the `1.2-dev` branch of libmongoc and libbson as
-during the development of phongo there are things we require that simply
-are not yet in a release (or even finished) :)
-
-
 ## Testing
 
 The test suites expects to find `PHONGO-SERVERS.json` in the system temp directory (typically `/tmp`).

README.md

@@ -3,18 +3,27 @@
 [![Build Status](https://api.travis-ci.org/mongodb/mongo-php-driver.png?branch=master)](https://travis-ci.org/mongodb/mongo-php-driver)
 [![Coverage Status](https://coveralls.io/repos/mongodb/mongo-php-driver/badge.svg?branch=master&service=github)](https://coveralls.io/github/mongodb/mongo-php-driver?branch=master)
 
-The purpose of this driver is to provide a thin glue between MongoDB
-and PHP, implementing only fundamental and performance-critical components
+This is the low-level PHP driver for MongoDB. The API is the same
+as the HHVM driver for MongoDB. The documentation for both of them is the same,
+and can be found at http://docs.php.net/manual/en/set.mongodb.php
+
+The driver is written to be a bare bone layer to talk to MongoDB, and
+therefore misses many convenience features. Instead, these convenience methods
+have been split out into a layer written in PHP, the
+[MongoDB Library](http://mongodb.github.io/mongo-php-library/).
+Using this library should be your preferred way of interacting with MongoDB.
+
+Please note that the new HHVM and PHP drivers implement a **different API**
+from the legacy driver at http://pecl.php.net/package/mongo; therefore 
+existing libraries that use the legacy driver (e.g. 
+[Doctrine MongoDB's ODM](http://doctrine-mongodb-odm.readthedocs.org/en/latest/))
+will not work with the new drivers.
 
 In the long run, we hope that userland packages will be built atop this driver
 to implement various APIs (e.g. a BC layer for the existing driver, new fluent
 interfaces), management utilities (for creating admin utilities and cluster
 management applications), and other interesting libraries.
 
-The goal is to encourage community contribution and involvement with these
-components (with a lower barrier of entry) while also keeping the overall design
-fast and powerful.
-
 ## Documentation
 - http://docs.php.net/set.mongodb
 - http://mongodb.github.io/mongo-php-driver
@@ -37,7 +46,7 @@ which is distributed as
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)
 
-## Related projects
+## Related Projects
 - [HHVM Implementation of this driver](https://github.com/mongodb/mongo-hhvm-driver)
 - [Official high-level library](https://github.com/mongodb/mongo-php-library)
 - [MongoDB Transistor](https://github.com/bjori/mongo-php-transistor) Lightweight ODM using the [Persistable](http://php.net/bson\\persistable) interface