Skip to content

Commit feb0377

Browse files
author
Gabriel Montalvo
committed
adds MongoLab -> mLab name change to the doc
1 parent ed31423 commit feb0377

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# mongolab-data-api [![Build Status](https://travis-ci.org/gmontalvoriv/mongolab-data-api.svg?branch=master)](https://travis-ci.org/gmontalvoriv/mongolab-data-api) [![npm version](https://badge.fury.io/js/mongolab-data-api.svg)](https://badge.fury.io/js/mongolab-data-api)
22

3-
`mongolab-data-api` is a node.js module designed to allow you to access [MongoLab's Data API](http://docs.mongolab.com/data-api/#reference) with minimal overhead.
3+
`mongolab-data-api` is a node.js module designed to allow you to access [mLab's Data API](http://docs.mlab.com/data-api/#reference) with minimal overhead.
44

55
I designed mongolab-data-api so the only documentation you need, in addition to the Data API specification, is how to install node, how to install the module, and how to make a call.
66

@@ -20,15 +20,15 @@ If you don't have or don't want to use npm:
2020
To require the library and initialize it with your account API key:
2121

2222
```javascript
23-
var mongolab = require('mongolab-data-api')('<Your Api Key Here>');
23+
var mLab = require('mongolab-data-api')('<Your Api Key Here>');
2424
```
2525

2626
### Examples
2727

2828
**List databases**
2929

3030
```javascript
31-
mongolab.listDatabases(function (err, data) {
31+
mLab.listDatabases(function (err, data) {
3232
if (err) { console.log(err); }
3333
else {
3434
console.log(data); // => [db1, db2, db3, ...]
@@ -39,7 +39,7 @@ mongolab.listDatabases(function (err, data) {
3939
**List collections**
4040

4141
```javascript
42-
mongolab.listCollections('exampledb', function (err, collections) {
42+
mLab.listCollections('exampledb', function (err, collections) {
4343
console.log(collections); // => [coll1, coll2, ...]
4444
});
4545
```
@@ -53,7 +53,7 @@ var options = {
5353
query: '{ "key": "value" }'
5454
};
5555

56-
mongolab.listDocuments(options, function (err, data) {
56+
mLab.listDocuments(options, function (err, data) {
5757
console.log(data); //=> [ { _id: 1234, ... } ]
5858
});
5959
```
@@ -221,23 +221,23 @@ commands| the document's id | `Object` | Yes |
221221

222222
## Requirements
223223

224-
- A [MongoLab](https://mongolab.com/) account w/API key.
224+
- [mLab](https://mlab.com/) account w/API key.
225225
- node.js v4.2.6+ (4.2.6 is the version I used to develop this module. I'm
226226
unsure if it will work with previous ones. If you run a previous version, and
227227
it works, let me know and I'll update this)
228228
- [xmlhttprequest](https://github.com/driverdan/node-XMLHttpRequest) 1.8.0+
229229

230230
## Disclaimer
231231

232-
### [From the official MongoLab Data API documentation](http://docs.mongolab.com/connecting/#methods):
232+
### [From the official mLab Data API documentation](http://docs.mlab.com/connecting/#methods):
233233

234-
> MongoLab databases can be accessed by your application code in two ways.
234+
> mLab databases can be accessed by your application code in two ways.
235235
236236
> The first method - the one we strongly recommend - is to connect using one of the MongoDB drivers (as described above). You do not need to use our API if you use the driver. In fact, using a driver provides better performance, better security, and more functionality.
237237
238-
> The second method is to connect via MongoLab’s RESTful Data API. Use this method only if you cannot connect using a MongoDB driver.
238+
> The second method is to connect via mLab’s RESTful Data API. Use this method only if you cannot connect using a MongoDB driver.
239239
240-
> ***Visit MongoLab's official documentation if you have any security concerns about using the Data API***
240+
> ***Visit mLab's official documentation if you have any security concerns about using the Data API***
241241
242242
## Contributions
243243

0 commit comments

Comments
 (0)