summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRob Loach <robloach@gmail.com>2014-04-30 00:20:26 -0400
committerRob Loach <robloach@gmail.com>2014-04-30 00:20:26 -0400
commit7ca89a5eb6c7993658c9efce339f6805a0ee8351 (patch)
treee41f695037a93e0fb4df47b105170090c55198a5
parent41194dde2c4950ac519cfb09c35aa6056d445875 (diff)
downloadgit-deploy-7ca89a5eb6c7993658c9efce339f6805a0ee8351.zip
git-deploy-7ca89a5eb6c7993658c9efce339f6805a0ee8351.tar.gz
git-deploy-7ca89a5eb6c7993658c9efce339f6805a0ee8351.tar.bz2
Update README.md
-rw-r--r--README.md41
1 files changed, 23 insertions, 18 deletions
diff --git a/README.md b/README.md
index 50a0438..2769c29 100644
--- a/README.md
+++ b/README.md
@@ -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