summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..51d629d
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,14 @@
+# Git-Auto-Deploy documentation
+
+# Documents
+
+* [Configuration options](./Configuration.md)
+* [Install as a python module (experimental)](./Install as a python module.md)
+* [Install as a debian package (experimental)](./Install as a debian package.md)
+* [Start automatically on boot (init.d and systemd)](./Start automatically on boot.md)
+
+# Example workflows
+
+## Continuous Delivery via Pull requests (GitHub only)
+
+It's possible to configure Git-Auto-Deploy to trigger when pull requests are opened or closed on GitHub. To read more about this workflow and how to configure Git-Aut-Deploy here: [Continuous Delivery via Pull requests](./Continuous Delivery via Pull requests.md)