From 54be7ea780c4eea57a1abde7028726cf1f713808 Mon Sep 17 00:00:00 2001
From: Achilleas Pipinellis <axilleas@axilleas.me>
Date: Tue, 5 Apr 2016 18:03:17 +0300
Subject: [PATCH] Update README

---
 README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 77 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9c81812..e6ba632 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,77 @@
-Example [Hexo](http://hexo.io/) site using GitLab Pages. Read more at https://doc.gitlab.com/ee/pages/
\ No newline at end of file
+![Build Status](https://gitlab.com/pages/hexo/badges/master/build.svg)
+
+---
+
+Example [Hexo] website using GitLab Pages.
+
+Learn more about GitLab Pages at https://pages.gitlab.io and the official
+documentation http://doc.gitlab.com/ee/pages/README.html.
+
+---
+
+## `.gitlab-ci.yml` contents
+
+This project's static Pages are built by [GitLab CI][ci], following the steps
+defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
+
+```
+image: node:4.2.2
+
+pages:
+  cache:
+    paths:
+    - node_modules/
+
+  script:
+  - npm install hexo-cli -g
+  - npm install
+  - hexo deploy
+  artifacts:
+    paths:
+    - public
+  only:
+  - master
+```
+
+## Building locally
+
+To work locally with this project, you'll have to follow the steps below:
+
+1. Fork, clone or download this project
+1. [Install][] Hexo
+1. Install dependencies: `npm install`
+1. Generate the website: `hexo generate`
+1. Preview your project: `hexo server`
+1. Add content
+
+Read more at Hexo's [documentation][].
+
+## GitLab User or Group Pages
+
+To use this project as your user/group website, you will need one additional
+step: just rename your project to `namespace.gitlab.io`, where `namespace` is
+your `username` or `groupname`. This can be done by navigating to your
+project's **Settings**.
+
+Read more about [user/group Pages][userpages] and [project Pages][projpages].
+
+## Did you fork this project?
+
+If you forked this project for your own use, please go to your project's
+**Settings** and remove the forking relationship, which won't be necessary
+unless you want to contribute back to the upstream project.
+
+## Troubleshooting
+
+1. CSS is missing! That means two things:
+
+    Either that you have wrongly set up the CSS URL in your templates, or
+    your static generator has a configuration option that needs to be explicitly
+    set in order to serve static assets under a relative URL.
+
+[ci]: https://about.gitlab.com/gitlab-ci/
+[hexo]: https://hexo.io
+[install]: https://hexo.io/docs/index.html#Installation
+[documentation]: https://hexo.io/docs/
+[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
+[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
-- 
GitLab