diff options
| -rw-r--r-- | README.md | 41 |
1 files changed, 23 insertions, 18 deletions
@@ -6,35 +6,40 @@ 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'));" -``` + + ``` 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 -``` + + ``` 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" - } -``` + + ``` 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 -``` + + ``` 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 -``` + + ``` bash + gh-pages-deploy/bin/gh-pages-deploy deploy + ``` ## License |