diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 36 |
1 files changed, 10 insertions, 26 deletions
@@ -1,40 +1,25 @@ # GitHub Pages Deploy -[](https://travis-ci.org/RobLoach/GitHubPagesDeploy) -[](https://coveralls.io/r/RobLoach/GitHubPagesDeploy?branch=master) -[](https://packagist.org/packages/RobLoach/GitHubPagesDeploy) -[](https://packagist.org/packages/RobLoach/GitHubPagesDeploy) - Deploys a number of repositories using the `gh-pages` branch, and keep the up to date. -## Installation -GitHub Pages Deploy can be installed with [Composer](http://getcomposer.org) -by adding it as a dependency to your project's composer.json file. +## Installation -```json -{ - "require-dev": { - "robloach/gh-pages-deploy": "*" - } -} +1. Install Composer: +``` bash +$ php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));" ``` -Please refer to [Composer's documentation](https://github.com/composer/composer/blob/master/doc/00-intro.md#introduction) -for more detailed installation and usage instructions. - -## Usage - -1. Download GitHub Pages Deploy with Composer - +2. Use Composer to download GitHub Pages Deploy: ``` bash -$ php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));" -$ php composer.phar create-project robloach/php-pages-deploy +$ php composer.phar create-project robloach/gh-pages-deploy ``` -2. Create a `gh-pages-deploy.json` file: +## Usage + +1. Create a `gh-pages-deploy.json` file: ``` json { "mywebsite": "https://github.com/my/website.git", @@ -42,8 +27,7 @@ $ php composer.phar create-project robloach/php-pages-deploy } ``` -3. Execute GitHub Pages Deploy - +2. Execute GitHub Pages Deploy to deploy all sites: ``` bash $ gh-pages-deploy/bin/gh-pages-deploy deploy ``` |