From b4f218dc6bf2fe2c7d3724f50e8c744049899565 Mon Sep 17 00:00:00 2001 From: Anton Medvedev Date: Sun, 26 Mar 2017 14:17:01 +0700 Subject: [PATCH] Update README.md --- README.md | 65 +++++++++++-------------------------------------------- 1 file changed, 13 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index eb976e2e..2d7fd37d 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,24 @@ -

- -

+# Deployer -

Build Status Code Quality +Code Quality Total Downloads Latest Stable Version License -

-## About Deployer - -[![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. +A deployment tool written in PHP with support for popular frameworks out of the box 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 -* PHP 5.6.0 and up. - -That's all! - -You can enable [sockets](http://php.net/manual/en/book.sockets.php) to speedup deployment process with parallel deployment. - -## 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. +* **Simple** setup process and a minimal learning curve +* Ready to use recipes for **most frameworks** +* **Parallel** execution without extensions +* Something went wrong? **Rollback** to the previous release +* **Agentless**, it's just SSH +* **Zero downtime** deployments ## 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)) -## 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 * 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. ## 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). +[![Becoming a patron](https://img.shields.io/badge/become-patron-brightgreen.svg)](https://www.patreon.com/deployer) + ## License Licensed under the [MIT license](http://opensource.org/licenses/MIT).