From 4fc1cf5d81de65c17f03a37a5e6432bf19086e5c Mon Sep 17 00:00:00 2001
From: Jonathan Gray <jonathan.gray@flowminder.org>
Date: Wed, 16 Sep 2020 11:07:41 +0100
Subject: [PATCH] Add binder to readme

---
 README.md | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e260e3c1..97078f90 100644
--- a/README.md
+++ b/README.md
@@ -55,9 +55,23 @@ markdown_extensions:
     - codehilite
 ```
 
-## Example
+### Binder
+
+You can also choose to have mknotebooks insert a [Binder](https://mybinder.org) link into each notebook.
+
+``` mkdocs.yml
+- mknotebooks:
+      binder: true
+      binder_service_name: "gh"
+      binder_branch: "master"
+```
+
+If you are using GitLab, you will need to set `binder_service_name` to `"gl"`.
+
+## Examples
+
+Example docs projects demonstrating the [use of a preamble](examples/execute_with_preamble) and [Binder](examples/binder_logo) are. Try them out by running `pipenv install && pipenv run mkdocs serve`.
 
-An [example docs project](examples/execute_with_preamble) demonstrating the above is included. Try it out by running `pipenv install && pipenv run mkdocs serve`.
 
 ## Inspecting generated markdown