From efa10158aa1b6dc8477cd1db7715825644644d58 Mon Sep 17 00:00:00 2001
From: Futtetennista <futtetennista@pm.me>
Date: Mon, 8 Aug 2022 14:42:51 +0100
Subject: [PATCH] Add examples for flags in README

I couldn't find any documentation of flags and I ended up looking at the code. It wasn't clear to me from the current docs:

1. what was the top-level object name
2. wether individual flags had to be specified as objects or a list
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index b55fe14d..6cf46986 100644
--- a/README.md
+++ b/README.md
@@ -332,6 +332,20 @@ This is done to allow compatibility with a wider range of `Cabal` versions.
 | `manual` | · | | Required (unlike Cabal) |
 | `default` | · | | Required (unlike Cabal) |
 
+Flags must be specified as an object:
+
+```
+flags:
+  development:
+    description: A development or production build 
+    manual: True
+    default: False
+  fast:
+    manual: True
+    default: False
+
+```
+
 #### Dependencies
 
 Dependencies can be specified as either a list or an object. These are