Update README.md

This commit is contained in:
Anton Medvedev 2017-03-26 14:17:01 +07:00
parent d85952e6ea
commit b4f218dc6b

View File

@ -1,55 +1,24 @@
<p align="center"> # Deployer
<a href="https://deployer.org" target="_blank"><img width="243" src="https://raw.githubusercontent.com/deployphp/deployer.org/master/public/images/deployer.png?v2"></a>
</p>
<p align="center">
<a href="https://travis-ci.org/deployphp/deployer"><img src="https://travis-ci.org/deployphp/deployer.svg?branch=master" alt="Build Status"></a> <a href="https://travis-ci.org/deployphp/deployer"><img src="https://travis-ci.org/deployphp/deployer.svg?branch=master" alt="Build Status"></a>
<a href="https://scrutinizer-ci.com/g/deployphp/deployer/"><img src="http://img.shields.io/scrutinizer/g/deployphp/deployer.svg?style=flat" alt="Code Quality"></a> <a href="https://scrutinizer-ci.com/g/deployphp/deployer/"><img src="http://img.shields.io/scrutinizer/g/deployphp/deployer.svg?style=flat" alt="Code Quality"></a>
<a href="https://scrutinizer-ci.com/g/deployphp/deployer/code-structure/master/code-coverage"><img src="https://img.shields.io/scrutinizer/coverage/g/deployphp/deployer/master.svg?style=flat" alt="Code Quality"></a>
<a href="https://packagist.org/packages/deployer/deployer"><img src="https://img.shields.io/packagist/dt/deployer/deployer.svg" alt="Total Downloads"></a> <a href="https://packagist.org/packages/deployer/deployer"><img src="https://img.shields.io/packagist/dt/deployer/deployer.svg" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/deployer/deployer"><img src="http://img.shields.io/packagist/v/deployer/deployer.svg?style=flat" alt="Latest Stable Version"></a> <a href="https://packagist.org/packages/deployer/deployer"><img src="http://img.shields.io/packagist/v/deployer/deployer.svg?style=flat" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/deployer/deployer"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License"></a> <a href="https://packagist.org/packages/deployer/deployer"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License"></a>
</p>
## About Deployer A deployment tool written in PHP with support for popular frameworks out of the box
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/69072898-df4a-4dee-ab05-c2ae83d6c469/big.png)](https://insight.sensiolabs.com/projects/69072898-df4a-4dee-ab05-c2ae83d6c469)
Deployer is a deployment tool written in PHP.
See [deployer.org](https://deployer.org) for more information and documentation. See [deployer.org](https://deployer.org) for more information and documentation.
Support Deployer development by [![Becoming a patron](https://img.shields.io/badge/become-patron-brightgreen.svg)](https://www.patreon.com/deployer) ## Features
## Requirements * **Simple** setup process and a minimal learning curve
* PHP 5.6.0 and up. * Ready to use recipes for **most frameworks**
* **Parallel** execution without extensions
That's all! * Something went wrong? **Rollback** to the previous release
* **Agentless**, it's just SSH
You can enable [sockets](http://php.net/manual/en/book.sockets.php) to speedup deployment process with parallel deployment. * **Zero downtime** deployments
## Installation
To install Deployer download [deployer.phar](https://deployer.org/deployer.phar) archive and move deployer.phar to your bin directory and make it executable.
``` sh
curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep
```
To upgrade Deployer run command:
``` sh
dep self-update
```
Or via composer:
``` sh
composer require deployer/deployer
```
## Documentation
Documentation source can be found in [deployphp/docs](https://github.com/deployphp/docs) repository.
## Who is using Deployer? ## Who is using Deployer?
@ -60,24 +29,16 @@ Documentation source can be found in [deployphp/docs](https://github.com/deployp
If you are also using it, please let us know ([Edit this file](https://github.com/deployphp/deployer/edit/master/README.md)) If you are also using it, please let us know ([Edit this file](https://github.com/deployphp/deployer/edit/master/README.md))
## Roadmap
* Better documentation.
* Better DX with intelligible errors.
* Better parallel task runner based on https://github.com/icicleio/icicle
* Task grouping for parallel execution.
* Task combining for less ssh calls.
* Implement `dep status` command with health-check of running application and deployment log.
* More deploy strategies.
* More integration with third-party services.
* Web-based client.
## Maintainers ## Maintainers
* Anton Medvedev [@antonmedv](https://github.com/antonmedv) * Anton Medvedev [@antonmedv](https://github.com/antonmedv)
See also the list of [contributors](https://github.com/deployphp/deployer/graphs/contributors) who participated in this project. See also the list of [contributors](https://github.com/deployphp/deployer/graphs/contributors) who participated in this project.
## Support ## Support
Deployer is an open source project. If you want to support the development of Deployer visit our [patreon page](https://www.patreon.com/deployer). Deployer is an open source project. If you want to support the development of Deployer visit our [patreon page](https://www.patreon.com/deployer).
[![Becoming a patron](https://img.shields.io/badge/become-patron-brightgreen.svg)](https://www.patreon.com/deployer)
## License ## License
Licensed under the [MIT license](http://opensource.org/licenses/MIT). Licensed under the [MIT license](http://opensource.org/licenses/MIT).