From 61f206e110cdcb9ce82877055e8c7416b28feeb9 Mon Sep 17 00:00:00 2001
From: Josh Dzielak <dzello@users.noreply.github.com>
Date: Thu, 26 Apr 2018 16:12:22 -0700
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index fd927cc..fc87d75 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,60 @@
 A Hugo theme for creating [Reveal.js](https://revealjs.com/) presentations that allows you to put multiple slides in the same markdown file.
 
 ![screenshot of reveal-hugo](/images/reveal-hugo.png)
+
+The motivation behind creating this theme is pretty simple - I didn't want to have to manage one markdown file for every slide, which would add the overhead of coming up with a file name, setting a `weight` param in the front matter to keep it in order, etc, all for just a few lines of text. Instead, I like to organize groups of slides into a smaller number of markdown files, each representing a section of the presentation.
+
+### Example
+
+Using reveal-hugo, a three-slide presentation can be created with just one markdown file, like so:
+
+```markdown
+# English
+Hello.
+
+---
+
+# Français
+Salu.
+
+---
+
+# Espagñol
+Hola.
+```
+
+The only requirement is to demarcate slides with `---` surrounded by newlines.
+
+# Demo
+
+Visit [https://reveal-hugo.netlify.com/](https://reveal-hugo.netlify.com/) to see an presentation created with this theme that shows more ways to use it.
+
+# Usage
+
+To create the presentation, the theme will look for all Hugo pages that have a type of `reveal`. That means they're in a `reveal` directory in the `content` folder OR the type is manually set to `reveal` in the front matter.
+
+```toml
+type = 'reveal'
+```
+
+Use the `weight` param in the front matter to specify the order that the pages should appear in the presentation.
+
+```toml
+weight = 20
+```
+
+### Fragments
+
+Fragments are a Reveal.js concept that lets you introduce content into each slide incrementally. Borrowing the concept from [hugo-theme-revealjs](https://github.com/RealOrangeOne/hugo-theme-revealjs), you can use a `fragment` shortcode to accomplish this in reveal-hugo in the same way.
+
+```markdown
+# Let's count to three...
+{{% fragment %}} One {{% /fragment %}}
+{{% fragment %}} Two {{% /fragment %}}
+{{% fragment %}} Three {{% /fragment %}}
+```
+
+
+# Configuration
+
+- `params.reveal_theme`: The Reveal.js theme used, defaults to "black"