summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeoffrey Bauvin <jeoffrey.bauvin.ext@boursorama.fr>2015-10-26 11:36:42 +0100
committerJeoffrey Bauvin <jeoffrey.bauvin.ext@boursorama.fr>2015-10-26 11:36:42 +0100
commit521c9bcc1aa7e62af0121575a4952d62fa306582 (patch)
tree73eb4c7db9c4c8b597456a45fbce87e7e5b6444e
Add Readme
-rw-r--r--README.markdown16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..620e9dc
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,16 @@
+####Table of Contents
+
+1. [Overview](#overview)
+2. [Module Description - What the module does and why it is useful](#module-description)
+3. [Setup - The basics of getting started with gitlab-ci-multi-runner](#setup)
+ * [What gitlab-ci-multi-runner affects](#what-gitlab-ci-multi-runner-affects)
+ * [Setup requirements](#setup-requirements)
+ * [Beginning with gitlab-ci-multi-runner](#beginning-with-gitlab-ci-multi-runner)
+4. [Usage - Configuration options and additional functionality](#usage)
+5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+5. [Limitations - OS compatibility, etc.](#limitations)
+6. [Development - Guide for contributing to the module](#development)
+
+##Overview
+
+The gitlab-ci-multi-runner module lets you use Puppet to install, configure, and manage Gitlab-ci-multi-runner, for Gitlab Continuous Integration.