From db941391ca9515e272db5bb909641e5190d8976d Mon Sep 17 00:00:00 2001
From: Jake Howard <git@theorangeone.net>
Date: Sun, 8 Dec 2019 19:33:13 +0000
Subject: [PATCH] Add some writeup to readme

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index 1b7195c..8bab0be 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,24 @@
 
 ![Ansible Status](https://github.com/realorangeone/infrastructure/workflows/Ansible/badge.svg)
 ![Generic Linting](https://github.com/realorangeone/infrastructure/workflows/Lint/badge.svg)
+
+## Requirements
+
+- Python 3
+- Locally configured SSH config (ideally deployed through [dotfiles](https://github.com/realorangeone/dotfiles))
+
+## Installation
+
+`./scripts/setup.sh`
+
+### Private Settings
+
+The ansible vault password needs setting in `ansible/.vault_pass`.
+
+## Deploying
+
+`./scripts/deploy.sh`
+
+Alternatively, each component can be deployed separately:
+
+- `./scripts/ansible.sh`