From f65ffef425cbdcea7a9efa4394780493a5d52e3a Mon Sep 17 00:00:00 2001
From: Eric Eastwood <contact@ericeastwood.com>
Date: Thu, 27 Aug 2020 15:18:22 -0500
Subject: Add getting started development docs using included examples

Tips I found useful while developing https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/336

Thanks @jaime for the help!
---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e4e42c6c..e9cac06f 100644
--- a/README.md
+++ b/README.md
@@ -80,6 +80,11 @@ $ make
 $ ./gitlab-pages -listen-https ":9090" -root-cert=path/to/example.com.crt -root-key=path/to/example.com.key -pages-root path/to/gitlab/shared/pages -pages-domain example.com
 ```
 
+### Getting started with development
+
+See [docs/development.md](docs/development.md)
+
+
 ### Run daemon **in secure mode**
 
 When compiled with `CGO_ENABLED=0` (which is the default), `gitlab-pages` is a
@@ -287,6 +292,13 @@ pages-domain=example.com
 use-http2=false
 ```
 
+
+
+### Testing and linting
+
+See [docs/development.md](docs/development.md)
+
+
 ### License
 
 MIT
-- 
cgit v1.2.3