parade-preshow 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Parade::Preshow
 
-TODO: Write a gem description
+Adds a time configurable preshow to a Parade presentation, allowing you to present images before your presentation starts.
 
 ## Installation
 
@@ -18,7 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Require it in your `parade` file:
+
+```ruby
+require 'parade-preshow'
+
+title "Example Presentation"
+
+description "My Awesome Presentation"
+
+section "Introduction" do
+  slides "intro.md"
+  slides "installation.md"
+  slides "navigation.md"
+end
+```
+
+Require it in your `config.ru` file:
+
+```ruby
+require "parade"
+require "parade-preshow"
+run Parade::Server.new
+```
+
+You can start the preshow by pressing the **p** key during your presentation
 
 ## Contributing
 

data/lib/parade-preshow.rb

@@ -29,4 +29,5 @@ module Parade
   Server.register Preshow::Server
   Server.register_javascript Preshow.javascript_file
   Server.register_stylesheet Preshow.stylesheet_file
+  Server.register_command "p", "toggle preshow"
 end

data/lib/parade-preshow/version.rb

@@ -1,5 +1,5 @@
 module Parade
   module Preshow
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parade-preshow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: