Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README and add package.json. Fixes #9
- Loading branch information
1 parent
a6de579
commit 8d6dead
Showing
2 changed files
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,26 @@ | ||
Cm_Mongo | ||
======== | ||
|
||
This Magento extension is primarily two things: | ||
|
||
# An abstraction layer for MongoDb. Like the MySQL abstraction layer included in Magento, it provides | ||
classes that extend Mage_Core_Model_Abstract and Varien_Data_Collection. It also includes support for | ||
.js upgrade scripts, an indexer to automatically index fields in other collections, and a schema | ||
defined by XML files. | ||
# An atomic job queue. The job queue can be run by the Magento cron or by a separate script and supports | ||
future execution dates, automatic retry intervals, disabling jobs by name or group name, and priorities. | ||
|
||
See @code/etc/mongo.xml.sample@ and @code/Model/Job.php@ for more information. | ||
|
||
Unit Testing | ||
------------ | ||
|
||
This module can be used with [EcomDev_PhpUnit](https://github.com/IvanChepurnyi/EcomDev_PHPUnit), | ||
Cm_Mongo can be used with [EcomDev_PhpUnit](https://github.com/IvanChepurnyi/EcomDev_PHPUnit), | ||
but needs to override one of it's classes for fixtures with mongo collections to work. Add a module | ||
dependency on EcomDev_PhpUnit to Cm_Mongo.xml when using with EcomDev_PhpUnit. | ||
|
||
|
||
License | ||
------- | ||
|
||
Please see the terms defined in LICENSE.md | ||
Please see the terms defined in LICENSE.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
{ | ||
"name": "colinmollenhour/magento-mongo", | ||
"type": "magento-module", | ||
"license":"BSD-3-Clause", | ||
"description":"MongoDb abstraction layer and atomic job queue for Magento.", | ||
"authors":[ | ||
{ | ||
"name":"Colin Mollenhour", | ||
"email":"colin@mollenhour.com" | ||
} | ||
], | ||
"require": { | ||
"magento-hackathon/magento-composer-installer": "*" | ||
} | ||
} |