Merge branch 'pr6'

Author: yaroot

README.md

@@ -1,38 +1,28 @@
 
 # Gitbucket-Pages-Plugin [![Gitter](https://img.shields.io/gitter/room/gitbucket/gitbucket.js.svg?style=flat-square)](https://gitter.im/gitbucket/gitbucket) [![Travis](https://img.shields.io/travis/yaroot/gitbucket-pages-plugin.svg?style=flat-square)](https://travis-ci.org/yaroot/gitbucket-pages-plugin)
 
-This plugin provides *Project Pages* for
-[GitBucket](https://github.com/gitbucket/gitbucket).
+This plugin provides *Project Pages* functionality for
+[GitBucket](https://github.com/gitbucket/gitbucket) based repositories.
 
 ## User guide
 
-This plugin would serve static file under `gh-pages` branch under
+This plugin can serve static files from a special orphan branch called `gh-pages` under
 `<base url>/<user>/<project>/pages/`.
 
 ### Quick start
 
-- checkout orphan branch via `git checkout --orphan && git rm -f $(git ls-files)`
-- `echo '<h1>hello, world</h1>' > index.html`
-- commit && push to gitbucket
-- open browser and point to `<your repo url>/pages`
+- create an orphan branch called `gh-pages` using `git checkout --orphan gh-pages && git rm -f $(git ls-files)`
+- create a static site under this branch. E.g. `echo '<h1>hello, world</h1>' > index.html` to create a simple file.
+- commit && push to gitbucket this orphan branch
+- open the browser and point to `<your repo url>/pages`
 
-Whant's next?
-
-- generate the site using static website generator, like
-[jekyll](http://jekyllrb.com/) and [hugo](https://gohugo.io/)
-- or using documentation generator, like
-[sphinx](http://www.sphinx-doc.org/en/stable/) and
-[gitbook](https://www.gitbook.com/)
-- make the site look beautiful via some
-[templates](https://github.com/blog/1081-instantly-beautiful-project-pages)
-
-**note**: this plugin won't render markdown for you, pre-build the
-site and commit all rendered files and resources into the repository
+**Note**: This plugin won't render markdown content. To render markdown content, use the wiki or one of the many static
+site generators.
 
 ## Installation
 
 - download from [releases](https://github.com/yaroot/gitbucket-pages-plugin/releases)
-- move the jar file to `<gitbucket_home>/plugins/` (`gitbucket_home` defaults to `~/.gitbucket`)
+- copy the jar file to `<GITBUCKET_HOME>/plugins/` (Note that `GITBUCKET_HOME` defaults to `~/.gitbucket`)
 - restart gitbucket and enjoy
 
 ## Versions
@@ -48,8 +38,8 @@ site and commit all rendered files and resources into the repository
 
 ## Security (panic mode)
 
-To prevent XSS, one must use two different domain to host pages and
-gitbucket. Below is a working example of nginx config to achieve that.
+To prevent XSS, one must use two different domains to host the pages and
+Gitbucket itself. Below is a working example of nginx configuration to achieve that.
 
 ```
 server {