summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 50a0438729928f38c80e88a9adee29eaa1ad4987 (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
34
35
36
37
38
39
40
41
42
43
44
# GitHub Pages Deploy

Deploy and maintain a number of static web applications on GitHub pages.


## 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
```

3. Set up a cron job to deploy every once in a while.
``` bash
$ gh-pages-deploy/bin/gh-pages-deploy deploy
```


## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)

Copyright © Rob Loach (http://robloach.net)