From 59f8b3f316e4788f39e91d7f7d3730e1f32c3288 Mon Sep 17 00:00:00 2001
From: Philip Howard <phil@gadgetoid.com>
Date: Tue, 24 Feb 2015 10:14:56 +0000
Subject: [PATCH] Update and rename overlay to overlay/README.md

---
 overlay/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 overlay/README.md

diff --git a/overlay/README.md b/overlay/README.md
new file mode 100644
index 0000000..d890c53
--- /dev/null
+++ b/overlay/README.md
@@ -0,0 +1,42 @@
+#Pinout Overlays
+
+A Pinout overlay describes the functions of the Raspberry Pi pins for a specific board.
+
+An overlay is constructed from a JSON file and, optionally, a markdown file containing an extended long-description.
+
+##JSON Format
+
+The JSON overlay file must include a name, manufacturer name, URL, description 
+( short description required, long is optional ) and a "pin" array.
+
+The pin array must list each pin by its *physical* location, and include at least a "name" describing the function
+of that pin.
+
+Optionally each pin definition can include an "exclusive" flag, which marks this pin as being unavailable for other
+use when it's occupied by this add-on.
+
+Things like i2c/SPI wont normally be flagged as exclusive, but most general purpose GPIO pins would, for example.
+
+Example:
+
+```json
+{
+	"name": "Pibrella",
+	"manufacturer": "Pimoroni",
+	"url": "https://github.com/pimoroni/pibrella",
+	"description": {
+		"short": "An all-in-one light, sound, input and output add-on board.",
+		"long": "pibrella.md"
+	},
+	"pin": {
+		"7": {
+			"name": "Green LED",
+			"exclusive": "true"
+		},
+		"11": {
+			"name": "Yellow LED",
+			"exclusive": "true"
+		}
+	}
+}
+```