Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updating readme

[git-p4: depot-paths = "//src/drawr/dev/": change = 3109]
  • Loading branch information...
commit 8ae8e81f1cc9a9e0546652ed2c4083babd937427 1 parent 9e1d26b
@tenderlove tenderlove authored
Showing with 36 additions and 8 deletions.
  1. +36 −8 README.txt
View
44 README.txt
@@ -1,32 +1,60 @@
drawr
- by FIX (your name)
- FIX (url)
+ by Aaron Patterson
+ http://seattlerb.org/
== DESCRIPTION:
-FIX (describe your package)
+This is a ruby wrapper around Plotr with a similar API to Gruff. You can
+create graphs with a similar interface to Gruff, but offload the rendering
+to the browser!
== FEATURES/PROBLEMS:
-* FIX (list of features or problems)
+* Needs more tests!
== SYNOPSIS:
- FIX (code sample of usage)
+An example in rails. Your controller:
+
+ class GraphController < ApplicationController
+ def index
+ @drawr = Drawr::Pie.new
+ @drawr.title = "Twan"
+ @drawr.data("One", [1])
+ @drawr.data('Two', [2])
+ @drawr.data('Three', [2])
+ @drawr.data('Four', [10])
+ @drawr.data('Five', [6])
+ end
+ end
+
+Your view:
+
+ <html>
+ <head>
+ <%= javascript_include_tag 'prototype' %>
+ <%= javascript_include_tag 'excanvas' %>
+ <%= javascript_include_tag 'Plotr' %>
+ </head>
+ <body>
+ <%= @drawr %>
+ </body>
+ </html>
== REQUIREMENTS:
-* FIX (list of requirements)
+* Plotr[http://www.solutoire.com/plotr]
== INSTALL:
-* FIX (sudo gem install, anything else)
+* sudo gem install drawr
+* require drawr in your environment.rb
== LICENSE:
(The MIT License)
-Copyright (c) 2007 FIX
+Copyright (c) 2007 Aaron Patterson
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Please sign in to comment.
Something went wrong with that request. Please try again.