more complete setup instructions

closes #1

Author: X1011

readme.md

@@ -3,24 +3,27 @@ This is a script for deploying generated files to a git branch, such as when bui
 For an example of use, see [X1011/verge-mobile-bingo](https://github.com/X1011/verge-mobile-bingo).
 
 ## configuration
-Edit these variables at the top of the script to fit your project:
+Download the script (`wget https://github.com/X1011/git-directory-deploy/raw/master/deploy.sh && chmod +x deploy.sh`) and edit these variables within it as needed to fit your project:
 
 - **deploy_directory**: root of the tree of files to deploy
 - **deploy_branch**: branch to commit files to and push to origin
 - **default_username**, **default_email**: identity to use for git commits if none is set already. Useful for CI servers.
-- **repo**: (optional) repository to deploy to. Must be readable and writable. The default of "origin" will not work on Travis CI, since it uses the read-only git protocol. In that case, it is recommended to store a [GitHub token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) in a [secure environment variable](http://about.travis-ci.org/docs/user/build-configuration/#Secure-environment-variables) and use it in an HTTPS URL like this: <code>repo=https://$GITHUB_TOKEN@github.com/<i>user</i>/<i>repo</i>.git</code>
+- **repo**: repository to deploy to. Must be readable and writable. The default of "origin" will not work on Travis CI, since it uses the read-only git protocol. In that case, it is recommended to store a [GitHub token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) in a [secure environment variable](http://about.travis-ci.org/docs/user/build-configuration/#Secure-environment-variables) and use it in an HTTPS URL like this: <code>repo=https://$GITHUB_TOKEN@github.com/<i>user</i>/<i>repo</i>.git</code>
 
 ## setup
-Do this once to prepare your repository. This could be implemented in the script, but I don’t feel like doing it. Replace "dist" with your deploy_directory and "gh-pages" with your deploy_branch.
+Do this once to set up a deploy branch if you don't already have one. This could be implemented in the script, but I don’t feel like doing it. Replace "dist" with your deploy_directory and "gh-pages" with your deploy_branch.
 
 1. `git --work-tree dist checkout --orphan gh-pages`
-   - this will disconnect the gh-pages branch’s history from the current commit
-   - in my app, the project root and dist had no files in common. If yours do, be careful if you don’t want to overwrite any existing files in dist
+	- this will disconnect the gh-pages branch’s history from the current commit
+	- in my app, the project root and dist had no files in common. If yours do, be careful if you don’t want to overwrite any existing files in dist
 2. `git --work-tree dist rm -r "*"`
-   - remove the source files we just checked out; these aren’t the files we’re looking for
-   - the quotes are required to prevent the shell from globbing in the current directory; we want git to glob in dist
+	- remove the source files we just checked out; these aren’t the files we’re looking for
+	- the quotes are required to prevent the shell from globbing in the current directory; we want git to glob in dist
 3. `git --work-tree dist add --all`
 4. `git --work-tree dist commit -m "initial publish"`
+5. `git push origin gh-pages`
+6. `git symbolic-ref HEAD refs/heads/master && git reset --mixed`
+	- switch back to master branch
 
 ## run
 Do this every time you want to deploy, or have your CI server do it.