docs: ✏️ Add options

biotope · Sep 20, 2019 · 066b63f · 066b63f
1 parent aee8397
commit 066b63f
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/Readme.md b/Readme.md
@@ -1 +1,8 @@
-# biotope-build-plugin-hbs
+# biotope-build-plugin-hbs
+
+## Options
+| Property          | Type     | Optional | Default                                                   | Description                            |
+|-------------------|----------|----------|-----------------------------------------------------------|----------------------------------------|
+| `srcPatterns`     | string[] | yes      | `['src/components/**/scaffolding/*.hbs']`                 | The handlebars templates to compile    |
+| `partialPatterns` | string[] | yes      | `['src/components/**/*.hbs']`                             | The partials to register for compiling |
+| `dataPatterns`    | string[] | yes      | `['src/components/**/*.json', 'src/resources/**/*.json']` | The data to use to fill the partials.  |