From 147be1a1acd22de8945b86926f5b6f79341e90ec Mon Sep 17 00:00:00 2001
From: Regis Philibert <login@regisphilibert.com>
Date: Tue, 19 May 2020 11:55:29 -0400
Subject: [PATCH] Add custom script doc to README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index f76f682..fac3404 100644
--- a/README.md
+++ b/README.md
@@ -84,4 +84,38 @@ fields:
 label: "Title"
 name: "title"
 widget: "string"
+```
+
+## Scripts
+
+The module faciliate the addiont of extra Netlify CMS scripts for WidgetPreviews, CollectionPreviews etc...
+
+By default the module prints the content of any `assets/netlifycms.js` file found inside a `<script>` tag.
+
+For more control, user should create its own `layouts/partials/tnd-netlifycms/scripts.html` partial and load the project's custom scripts there.
+
+### Custom Scripts Partial example: 
+
+In this example, we use the load the project's stylesheet for the Articles previews and fire the Custom Preview afterwards, using the project's own classes.
+
+```
+{{ $style := false }}
+{{ with resources.Get "css/style.css" }}
+  {{ $style = . | resources.PostCSS }} 
+{{ end }}
+<script>
+  {{ with $style }}
+  CMS.registerPreviewStyle("{{ $style.Permalink }}");
+  {{ end }}
+  var PostPreview = createClass({
+    render: function() {
+      var entry = this.props.entry;
+      return h('div', {"className": "px-4"},
+        h('h1', {"className": "text-5xl font-normal pt-10 mb-16"}, entry.getIn(['data', 'title'])),
+        h('div', {"className": "my-4 user-content"}, this.props.widgetFor('body'))
+      );
+    }
+  });
+  CMS.registerPreviewTemplate("articles", PostPreview);
+</script>
 ```
\ No newline at end of file