Skip to content

Commit 58e57be

Browse files
committed
Update README
1 parent d995846 commit 58e57be

File tree

1 file changed

+43
-20
lines changed

1 file changed

+43
-20
lines changed

README.md

+43-20
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,68 @@
1-
MongoDB library for PHP
2-
=======================
1+
# MongoDB PHP Library
32

4-
This library provides a high-level abstraction around the lower-level drivers for
5-
[PHP](https://github.com/mongodb/mongo-php-driver) and
6-
[HHVM](https://github.com/mongodb/mongo-hhvm-driver) (i.e. the `mongodb`
7-
extension).
3+
[![Build Status](https://api.travis-ci.org/mongodb/mongo-php-library.png?branch=master)](https://travis-ci.org/mongodb/mongo-php-library)
4+
5+
This library provides a high-level abstraction around the lower-level
6+
[PHP driver](https://github.com/mongodb/mongo-php-driver) (`mongodb` extension).
87

98
While the extension provides a limited API for executing commands, queries, and
109
write operations, this library implements an API similar to that of the
11-
[legacy PHP driver](http://php.net/manual/en/book.mongo.php). It contains
10+
[legacy PHP driver](https://php.net/manual/en/book.mongo.php). It contains
1211
abstractions for client, database, and collection objects, and provides methods
1312
for CRUD operations and common commands (e.g. index and collection management).
1413

1514
If you are developing an application with MongoDB, you should consider using
1615
this library, or another high-level abstraction, instead of the extension alone.
1716

18-
For further information about the architecture of this library and the `mongodb`
19-
extension, see:
20-
21-
- http://www.mongodb.com/blog/post/call-feedback-new-php-and-hhvm-drivers
17+
Additional information about the architecture of this library and the `mongodb`
18+
extension may be found in
19+
[Architecture Overview](https://php.net/manual/en/mongodb.overview.php).
2220

2321
## Documentation
2422

2523
- https://docs.mongodb.com/php-library/
24+
- https://docs.mongodb.com/ecosystem/drivers/php/
2625

27-
# Installation
28-
29-
As a high-level abstraction for the driver, this library naturally requires that
30-
the [`mongodb` extension be installed](http://php.net/manual/en/mongodb.installation.php):
31-
32-
$ pecl install mongodb
33-
$ echo "extension=mongodb.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"`
26+
## Installation
3427

3528
The preferred method of installing this library is with
3629
[Composer](https://getcomposer.org/) by running the following from your project
3730
root:
3831

3932
$ composer require mongodb/mongodb
4033

34+
Additional installation instructions may be found in the
35+
[library documentation](https://docs.mongodb.com/php-library/current/tutorial/install-php-library/).
36+
37+
Since this library is a high-level abstraction for the driver, it also requires
38+
that the `mongodb` extension be installed:
39+
40+
$ pecl install mongodb
41+
$ echo "extension=mongodb.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"`
42+
43+
Additional installation instructions for the extension may be found in its
44+
[PHP.net documentation](https://php.net/manual/en/mongodb.installation.php).
45+
4146
## Reporting Issues
4247

43-
Please use the following form to report any issues:
48+
Issues pertaining to the library should be reported in the
49+
[PHPLIB](https://jira.mongodb.org/secure/CreateIssue!default.jspa?project-field=PHPLIB)
50+
project in MongoDB's JIRA. Extension-related issues should be reported in the
51+
[PHPC](https://jira.mongodb.org/secure/CreateIssue!default.jspa?project-field=PHPC)
52+
project.
53+
54+
For general questions and support requests, please use one of MongoDB's
55+
[Technical Support](https://docs.mongodb.com/manual/support/) channels.
56+
57+
### Security Vulnerabilities
58+
59+
If you've identified a security vulnerability in a driver or any other MongoDB
60+
project, please report it according to the instructions in
61+
[Create a Vulnerability Report](https://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report).
62+
63+
## Development
4464

45-
- https://jira.mongodb.org/secure/CreateIssue.jspa?pid=12483&issuetype=1
65+
Development is tracked in the
66+
[PHPLIB](https://jira.mongodb.org/projects/PHPLIB/summary) project in MongoDB's
67+
JIRA. Documentation for contributing to this project may be found in
68+
[CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)