Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.23 KB

MakeAModuleInstallableWithComposer.md

File metadata and controls

45 lines (36 loc) · 1.23 KB
Raw

Make a module installable with composer

To make a Magento module installable with composer, this is how to set up the composer.json for your extension:

{
    "name": "your-vendor-name/module-name",
    "type": "magento-module",
    "license":"OSL-3.0",
    "description":"A short one line description of your module",
    "authors":[
        {
            "name":"Author Name",
            "email":"[email protected]"
        }
    ]
}

If you would like to publish your module on https://packages.firegento.com/, please fork https://github.com/magento-hackathon/composer-repository, add your module to the satis.json on the master branch and open a pull request.

If you want to install your module without publishing it on https://packages.firegento.com/, you can add your repository to your projects composer.json directly and it will install, too.

{
    ...
    "repositories": [
        {
            "type": "vcs",
            "url": "your/github/or/git/or/svn/etc/repository/uri"
        }
    ],
    ...
}

More information can be found at http://getcomposer.org/doc/05-repositories.md#vcs