summaryrefslogtreecommitdiffstats
path: root/README.md
blob: c2313209e3572cbfb70f05193c91269fa8ac3bd1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# GitHub Pages Deploy

Deploys a number of repositories using the `gh-pages` branch, and keep the up to
date.


## Installation

1. Install Composer:
``` bash
$ php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));"
```

2. Use Composer to download GitHub Pages Deploy:
``` bash
$ php composer.phar create-project robloach/gh-pages-deploy
```


## Usage

1. Create a `gh-pages-deploy.json` file:
``` json
{
    "mywebsite": "https://github.com/my/website.git",
    "myotherwebsite": "https://github.com/my/otherwebsite.git"
}
```

2. Execute GitHub Pages Deploy to deploy all sites:
``` bash
$ gh-pages-deploy/bin/gh-pages-deploy deploy
```