docs: adds README.md

Author: r1b

README.md

@@ -0,0 +1,83 @@
+# gatsby-transformer-yaml-netlify
+
+Parses YAML files. Supports a data layout that is compatible with netlify-cms.
+
+## Install
+
+`npm install --save gatsby-transformer-yaml-netlify`
+
+## How to use
+
+```javascript
+// In your gatsby-config.js
+plugins: [
+  `gatsby-transformer-yaml-netlify`,
+]
+```
+
+## Parsing algorithm
+
+If you have a data layout like so:
+
+```
+data/
+    takers/
+        a-taker.yml  // value: a
+        b-taker.yml  // value: b
+    leavers/
+        a-leaver.yml // value: a
+        b-leaver.yml // value: b
+```
+
+Then four nodes will be created:
+
+```javascript
+[
+  {
+    value: 'a',
+    type: 'TakersYaml'
+  },
+  {
+    value: 'b',
+    type: 'TakersYaml'
+  },
+  {
+    value: 'a',
+    type: 'LeaversYaml'
+  },
+  {
+    value: 'b',
+    type: 'LeaversYaml'
+  }
+]
+```
+
+## How to query
+
+You'd be able to query your takers like:
+
+```graphql
+{
+  allTakersYaml {
+    edges {
+      node {
+        value
+      }
+    }
+  }
+}
+```
+
+And your leavers like:
+
+```graphql
+{
+  allLeaversYaml {
+    edges {
+      node {
+        value
+      }
+    }
+  }
+}
+```