Updated readme and docs

git-svn-id: http://topfunky.net/svn/plugins/calendar_helper@34 798a5b91-ee08-0410-b43b-a734d69ea54e
smtlaissezfaire · Apr 26, 2006 · bdba5e4 · bdba5e4
1 parent 08aa220
commit bdba5e4
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/README b/README
@@ -1,7 +1,9 @@
 CalendarHelper
 ==============
 
-A simple helper for generating an HTML calendar.
+A simple helper for creating an HTML calendar.
+
+There is also a Rails generator that copies some stylesheets for use alone or alongside existing stylesheets.
 
 Authors
 =======
@@ -15,3 +17,14 @@ Dynamic enhancements for starting week on Monday and highlighting weekends
 Geoffrey Grosenbach -- http://nubyonrails.com
 Test suite and conversion to a Rails plugin
 
+Usage
+=====
+
+See the RDoc (or use "rake rdoc").
+
+To copy the CSS files, use
+
+  ./script/generate calendar_styles
+
+CSS will be copied to subdirectories of public/stylesheets/calendar.
+
diff --git a/lib/calendar_helper.rb b/lib/calendar_helper.rb
@@ -46,7 +46,7 @@ module CalendarHelper
   #
   # An additional 'weekend' class is applied to weekend days. 
   #
-  # For consistency with the themes provided in the calendar_styles generator, use the "specialDay" as the CSS class for marked days.
+  # For consistency with the themes provided in the calendar_styles generator, use "specialDay" as the CSS class for marked days.
   # 
   def calendar(options = {}, &block)
     raise(ArgumentError, "No year given")  unless options.has_key?(:year)