foundry/masonry-register

This application keeps track of installed modules

0.1.1 2016-01-21 10:33 UTC

README

Minimum PHP Version License Version Build Status

Masonry Register is a plugin for Composer. It allows Masonry modules to be registered whenever the Composer dumps the autoloader (this happens on install, update and dump-autoload). It looks for and registers all the modules to allow Masonry to discover descriptions of work and the workers to process them.

Installation

Masonry Register comes with (and is pretty useless without) Masonry. It was included as a separate repository to allow users of Masonry to provide their own Registry package.

However, to install it independently via composer, use the following command from the command line:

composer require foundry/masonry-register -n

Note: This will still install Masonry as it is a required component

Overriding

This package is separated from the main Masonry package to allow it to be easily overridden by a package of your own.

To do so, you must use the "replace" property in your composer.json

It would look something like this:

"replace" : {
  "foundry/masonry-register" : "self.version"
}

Contributing

Contributions are very welcome! Please use the Issue tracker to make any feature requests, report bugs, etc.

If you'd like to contribute code:

  • Fork the project.
  • Write some code.
  • Add tests.
  • Send a pull request to the develop branch.