Fixed slides filenames, added two other examples and documentation

README.md

@@ -1,12 +1,12 @@
-# Jekyll & Reveal.js
+# jekyll-reveal.js
 
-A Jekyll-Site for creating presentations based on Reveal.js
+A Jekyll-based framework for creating presentations based on Reveal.js.
 
 ## Introduction
 
-If you like [Reveal.js][] for creating your online presentations and like the site
-management [Jekyll][] gives you, here's an easy way to create a presentation using
-Jekyll and Reveal.js
+If you like [Reveal.js][] for creating your online presentations, like the site
+management [Jekyll][] gives you and like Markdown because of its easy and clean look, 
+here's an easy way to create a presentation using Jekyll, Markdown and Reveal.js.
 
 ## Howto
 
@@ -27,13 +27,31 @@ and you're ready to go with building your presentation with Jekyll:
 
     jekyll build
 
-You can even manage multiple presentations using the power of git. Simple branch from the
+You can even manage multiple presentations using the power of git. Simply branch from the
 master branch to create a new presentation:
 
     git checkout master
     git branch presentation2
     git checkout presentation2
 
+## Slide filenames
+
+Because we're using the Jekyll posts-framework to easily gather the slides for the presentation, 
+we're bound to the conventions of Jekyll posts, namely being
+
+    <year>-<month>-<day>-<title>.md
+
+We recommend naming the files like
+
+    1-1-1-1-welcome.md
+    1-1-1-2-topics.md
+
+and so forth. 
+
+Jekyll will assume, that each post has been made on the first of january, 2001 (which is of no interest
+for a presentation). The additional number is for sorting purposes. After that comes a title to identify 
+the specific slide (which is actually only for the presentation author, Jekyll doesn't care about it).
+
 ## Configuring the presentation
 
 You can configure almost any reveal.js setting using the _config.yml-settings file in the
@@ -56,22 +74,11 @@ there and referencing that directory in the configuration "reveal_theme_path".
 Don't mess with the reveal.js subdirectory as it is a subrepository and doesn't adhere to your repository's
 branches.
 
-## Slide filenames
-
-Because we're using the Jekyll post framework here, we're bound to the conventions
-of Jekyll posts, namely being
-
-    <year>-<month>-<day>-<title>.md
-
-But everything should work well, if you just name the files
-
-    1-1-1-1.md
-    1-1-1-2.md
-
-and so forth.
-
 ## Markdown extensions and simplification
 
+Reveal.js already includes a markdown interpreter, which we use for jekyll-reveal.js. We have already
+configured it and included some simplification just for you!
+
 ### Multiple slides
 
 To use multiple slides in one slide file, use a newline, three dashes and another newline like this:
@@ -129,3 +136,14 @@ plugin:
 [options]: https://github.com/hakimel/reveal.js#configuration
 [depedencies]: https://github.com/hakimel/reveal.js#dependencies
 
+### Speaker notes
+
+jekyll-reveal.js is configured, so that speaker notes are identified after an introductory "Note:"-tag:
+
+    # Slide
+
+    Some slide content
+
+    Note:
+
+    This is only displayed in the speaker notes.

_posts/1-1-1-1-welcome.md

@@ -0,0 +1,3 @@
+## Welcome
+
+Welcome to the jekyll-reveal.js example presentation.

_posts/1-1-1-2-slides.md

@@ -0,0 +1,10 @@
+## Slide 2
+
+This is the second slide. And it's just another file inside the _posts-directory.
+
+It is identified as slide 2, because it has a "2" after the mandatory date-part (1-1-1) in its
+filename. (It's called 1-1-1-2-slides.md)
+
+---
+
+This is a third slide, although we're still in 1-1-1-2-slides.md.

_posts/1-1-1-6-notes.md

@@ -0,0 +1,7 @@
+# A hidden treasure
+
+This slide has a hidden treasure. Press "s" to see the speaker notes.
+
+Note:
+
+THIS TEXT IS HIDDEEEEEEEN! :)