From 7e28c54d02593ff6a4f774f6a33d030e8f5358ed Mon Sep 17 00:00:00 2001
From: Sam Beckham <sbeckham@gitlab.com>
Date: Tue, 5 Jun 2018 13:46:51 +0000
Subject: [PATCH] Update README.md

---
 README.md | 36 +++++++++++++++++++++++++++++++++---
 1 file changed, 33 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7598895..5eb5480 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,36 @@
-![Gitlab ❤️ VuePress](https://samdbeckham.gitlab.io/vuepress-gl-pages/hero.png)
-
 # VuePress GitLab pages template
 
 This repo contains all the starter files for running VuePress on GitLab pages.
-If you want to read more on VuePress, [check out their website](https://vuepress.vuejs.org/).
\ No newline at end of file
+If you want to read more on VuePress, [check out their website](https://vuepress.vuejs.org/).
+
+## Running locally
+
+This project uses [yarn](), you'll need to install this globally before you can get started.
+
+```
+npm install -g yarn
+```
+
+Then you need to install the project dependencies:
+
+```
+yarn install
+```
+
+Now you're ready to go.
+To run the local dev server just use the following command:
+
+```
+yarn start
+```
+
+## Building the site
+
+[.gitlab-ci.yml](./.gitlab-ci.yml) takes care of the deployment to GitLab pages.
+If you want to preview a build locally, you can run:
+
+```
+yarn build
+```
+
+This will build all your files into a `./public` directory.
\ No newline at end of file
-- 
GitLab