Provide basic docs

Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>
arcus-azure · Jan 2, 2019 · d145635 · d145635
1 parent 90e6b1f
commit d145635
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,8 @@
+Documentation
+====
+
+All documentation for Arcus Event Grid Sidecar which are published via GitHub Pages with Jekyll.
+
+## Running Jekyll locally
+
+Running Jekyll locally to test your changes is super easy, learn more about it [here](https://jekyllrb.com/docs/#instructions).
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,7 @@
+repository: arcus-azure/arcus.eventgrid.sidecar
+theme: jekyll-theme-slate
+logo: https://raw.githubusercontent.com/arcus-azure/arcus/master/media/arcus.png
+title: Arcus Event Grid Sidecar
+description: Sidecar for sending events to Azure Event Grid
+plugins:
+  - jemoji
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,21 @@
+---
+title: "Home"
+layout: default
+permalink: /
+redirect_from:
+ - /index.html
+---
+
+# Installation
+
+```shell
+PM > docker pull arcusazure/azure-event-grid-sidecar
+```
+
+# Features
+No features are supported yet.
+
+# License
+This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.
+
+*[Full license here](https://github.com/arcus-azure/arcus.eventgrid.sidecar/blob/master/LICENSE)*