From b33bbb6d4c886ae13710d51d55aa6c23e69240d5 Mon Sep 17 00:00:00 2001
From: Oliver Davies <oliver@oliverdavies.uk>
Date: Mon, 10 Jan 2022 22:39:37 +0000
Subject: [PATCH] docs: update README

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

diff --git a/README.md b/README.md
index 7327218f..1088b583 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,30 @@
 # dotfiles
 
-My personal dotfiles, originally for macOS only but currently being adapted for use on Linux based systems (Ubuntu and Pop!_OS in particular) where needed.
+My personal dotfiles, originally for macOS only but currently being adapted for
+use on Linux based systems (Ubuntu and Pop!_OS in particular) where needed.
+
+The repository is powered using Ansible, with each software package and its
+associated configuration within separate roles within the `roles` directory.
+
+The `neovim` role, for example, has its own tasks in `roles/neovim/tasks/main.yaml`
+and files in `roles/neovim/files`.
+
+Files within a role are typically symlinked into their required destination
+so that they will be automatically updated without needing to run the playbook
+again.
+
+For example, the files and directories within the neovim role are symlinked
+into `~/.config/nvim`.
+
+## Requirements
+
+- [Ansible](https://www.ansible.com)
+- [Git](https://git-scm.com)
 
 ## Installation
 
 ```
-stow alacritty bin composer dconf git nvim tmux zsh
+$ ansible-playbook main.yaml --ask-become-pass
 ```
 
 ## Inspiration