2012-11-08 14:07:42 +00:00
|
|
|
Composer - Dependency Management for PHP
|
|
|
|
========================================
|
2011-04-05 15:36:01 +00:00
|
|
|
|
2014-02-13 13:40:09 +00:00
|
|
|
Composer helps you declare, manage and install dependencies of PHP projects, ensuring you have the right stack everywhere.
|
2011-04-05 15:36:01 +00:00
|
|
|
|
2012-11-08 14:08:02 +00:00
|
|
|
See [https://getcomposer.org/](https://getcomposer.org/) for more information and documentation.
|
2011-10-02 21:38:27 +00:00
|
|
|
|
2014-12-02 14:41:25 +00:00
|
|
|
[![Build Status](https://travis-ci.org/composer/composer.svg?branch=master)](https://travis-ci.org/composer/composer)
|
2015-06-24 06:58:03 +00:00
|
|
|
[![Dependency Status](https://www.versioneye.com/php/composer:composer/dev-master/badge.svg)](https://www.versioneye.com/php/composer:composer/dev-master)
|
2015-05-11 11:32:10 +00:00
|
|
|
[![Reference Status](https://www.versioneye.com/php/composer:composer/reference_badge.svg?style=flat)](https://www.versioneye.com/php/composer:composer/references)
|
2011-11-16 12:54:17 +00:00
|
|
|
|
2011-10-02 21:38:27 +00:00
|
|
|
Installation / Usage
|
|
|
|
--------------------
|
|
|
|
|
2012-11-08 14:08:02 +00:00
|
|
|
1. Download the [`composer.phar`](https://getcomposer.org/composer.phar) executable or use the installer.
|
2012-01-23 11:10:49 +00:00
|
|
|
|
2012-02-14 14:31:05 +00:00
|
|
|
``` sh
|
2013-02-18 16:51:12 +00:00
|
|
|
$ curl -sS https://getcomposer.org/installer | php
|
2012-02-14 14:31:05 +00:00
|
|
|
```
|
2012-01-23 11:10:49 +00:00
|
|
|
|
2011-10-03 08:49:23 +00:00
|
|
|
2. Create a composer.json defining your dependencies. Note that this example is
|
2011-10-02 21:38:27 +00:00
|
|
|
a short version for applications that are not meant to be published as packages
|
2013-10-16 12:10:42 +00:00
|
|
|
themselves. To create libraries/packages please read the
|
2015-05-04 17:37:57 +00:00
|
|
|
[documentation](https://getcomposer.org/doc/02-libraries.md).
|
2011-10-02 21:38:27 +00:00
|
|
|
|
|
|
|
``` json
|
|
|
|
{
|
|
|
|
"require": {
|
|
|
|
"monolog/monolog": ">=1.0.0"
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
2011-11-20 21:02:22 +00:00
|
|
|
|
2011-10-03 08:49:23 +00:00
|
|
|
3. Run Composer: `php composer.phar install`
|
2012-11-08 14:08:02 +00:00
|
|
|
4. Browse for more packages on [Packagist](https://packagist.org).
|
2011-04-05 15:36:01 +00:00
|
|
|
|
2012-04-12 07:55:42 +00:00
|
|
|
Global installation of Composer (manual)
|
2012-01-08 17:14:50 +00:00
|
|
|
----------------------------------------
|
2011-11-04 10:55:08 +00:00
|
|
|
|
2015-05-04 17:37:57 +00:00
|
|
|
Follow instructions [in the documentation](https://getcomposer.org/doc/00-intro.md#globally)
|
2011-11-04 10:55:08 +00:00
|
|
|
|
2012-04-12 07:55:42 +00:00
|
|
|
Updating Composer
|
2012-01-08 17:14:50 +00:00
|
|
|
-----------------
|
2012-01-07 20:52:22 +00:00
|
|
|
|
2012-01-08 17:14:50 +00:00
|
|
|
Running `php composer.phar self-update` or equivalent will update a phar
|
2015-05-10 14:17:42 +00:00
|
|
|
install to the latest version.
|
2012-01-07 20:52:22 +00:00
|
|
|
|
2012-01-17 21:23:31 +00:00
|
|
|
Community
|
|
|
|
---------
|
|
|
|
|
2012-10-24 08:22:40 +00:00
|
|
|
IRC channels are on irc.freenode.org: [#composer](irc://irc.freenode.org/composer)
|
2012-01-17 21:23:31 +00:00
|
|
|
for users and [#composer-dev](irc://irc.freenode.org/composer-dev) for development.
|
|
|
|
|
2015-05-10 14:17:42 +00:00
|
|
|
For support, Stack Overflow also offers a good collection of
|
2015-05-04 17:37:57 +00:00
|
|
|
[Composer related questions](https://stackoverflow.com/questions/tagged/composer-php).
|
2012-10-24 08:22:40 +00:00
|
|
|
|
2015-05-10 14:17:42 +00:00
|
|
|
Please note that this project is released with a
|
2015-08-11 06:37:24 +00:00
|
|
|
[Contributor Code of Conduct](http://contributor-covenant.org/version/1/2/0/).
|
2015-05-10 14:17:42 +00:00
|
|
|
By participating in this project and its community you agree to abide by those terms.
|
|
|
|
|
2011-04-05 15:36:01 +00:00
|
|
|
Requirements
|
|
|
|
------------
|
|
|
|
|
2012-09-07 20:35:37 +00:00
|
|
|
PHP 5.3.2 or above (at least 5.3.4 recommended to avoid potential bugs)
|
2011-10-02 21:38:27 +00:00
|
|
|
|
|
|
|
Authors
|
|
|
|
-------
|
2011-04-05 15:36:01 +00:00
|
|
|
|
2015-05-04 17:37:57 +00:00
|
|
|
Nils Adermann - <naderman@naderman.de> - <https://twitter.com/naderman> - <http://www.naderman.de><br />
|
|
|
|
Jordi Boggiano - <j.boggiano@seld.be> - <https://twitter.com/seldaek> - <http://seld.be><br />
|
2011-04-16 12:42:35 +00:00
|
|
|
|
2011-06-28 18:37:31 +00:00
|
|
|
See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project.
|
2011-04-05 15:36:01 +00:00
|
|
|
|
|
|
|
License
|
|
|
|
-------
|
|
|
|
|
|
|
|
Composer is licensed under the MIT License - see the LICENSE file for details
|
|
|
|
|
2011-10-23 17:39:49 +00:00
|
|
|
Acknowledgments
|
|
|
|
---------------
|
2011-10-02 21:38:27 +00:00
|
|
|
|
2012-08-25 22:28:28 +00:00
|
|
|
- This project's Solver started out as a PHP port of openSUSE's
|
2015-05-04 17:37:57 +00:00
|
|
|
[Libzypp satsolver](https://en.opensuse.org/openSUSE:Libzypp_satsolver).
|
2012-08-25 22:28:28 +00:00
|
|
|
- This project uses hiddeninput.exe to prompt for passwords on windows, sources
|
2013-02-18 16:51:12 +00:00
|
|
|
and details can be found on the [github page of the project](https://github.com/Seldaek/hidden-input).
|