pbosetti-flotr 1.3.5 → 1.3.6

data/README.markdown

@@ -4,11 +4,22 @@ Flotr (pron.: like "plotter") is a plot/chart facility to be used within Ruby.
 
 It is intended to be as portable as possible, and is thus aimed to generate HTML plots thanks to the great [flot library](http://ryanfunduk.com/flot).
 
+Installation
+============
+First, you have to be sure to have the Github repository added to your rubygems configuration. This step only has to be performed the first time you install a gem hosted on Github:
+
+    gem sources -a http://gems.github.com
+
+Next, simply install the gem:
+
+    sudo gem install pbosetti-flotr
+
 Usage
 =====
-The following code produces the flotr.html file located in the root project folder:
+The following code produces the `flotr.html` file located in the current folder:
 
-    require "lib/flotr"
+    require "rubygems"
+    require "flotr"
     # Create a new plot
     plot = Flotr::Plot.new("Test plot")
 
@@ -25,15 +36,16 @@ The following code produces the flotr.html file located in the root project fold
     plot << sin << cos
     plot.show
 
-At the moment, the Flotr::Plot.plot method automatically opens the plot within a browser window under OS X and Windows. On other platforms (Linux) you have to open the generated file by hands.
+At the moment, the `Flotr::Plot.show` method automatically opens the plot within a browser window under OS X and Windows. On other platforms (Linux) you have to open the generated file by hands.
 
 The default template (since v1.3) allows zooming the plot. Reload the page to reset to full view.
 
 Templates
 =========
 Flotr uses templates for formatting the plots. Currently there are the following templates available:
-1. interacting: a simple layout that shows point coordinates on mouse hover
-2. zooming: a smaller overview is added on the right side of the main plot, allowing zooming of different plot areas
+
+1. `interacting`: a simple layout that shows point coordinates on mouse hover
+2. `zooming`: a smaller overview is added on the right side of the main plot, allowing zooming of different plot areas
 
 The current template can be selected as follows (amongst those installed by default):
 
@@ -47,7 +59,7 @@ Custom templates can be selected this way:
 
     p.template = "full/path/to/template.rhtml"
     
-Look within lib/*.rhtml for template examples. Templates follow the Erubis syntax.
+Look within `lib/*.rhtml` for template examples. Templates follow the Erubis syntax.
 
 Example
 =======

data/lib/flotr.rb

@@ -5,7 +5,7 @@
 # reserved.
 require "rubygems"
 require "erubis"
-require "CGI"
+require "cgi"
 
 class String
   def escapeHTML

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pbosetti-flotr
 version: !ruby/object:Gem::Version 
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors: 
 - Paolo Bosetti