README.md in simple_calendar-0.0.2 vs README.md in simple_calendar-0.0.3
- old
+ new
@@ -1,17 +1,17 @@
Simple Calendar
===============
-This is a small gem for creating a quick and clean table calendar.
+This is a small Rails 3.x gem for creating a quick and clean table calendar.
Theming is up to you, but it works nicely with Twitter Bootstrap.
Installation
------------
Just add this into your Gemfile followed by a bundle install:
- gem "simple_calendar", "~> 0.0.1"
+ gem "simple_calendar", "~> 0.0.3"
Usage
-----
Here we have a model called Event with the start_time attribute that we
@@ -34,10 +34,28 @@
has_calendar has options that can be passed to it for configuration:
has_calendar :start_time => :my_start_column
- def whatever
- title + " ohai"
- end
+The start_time option is the field for the start time of the event. This will use
+my_start_column to determine which day to render the event on.
-Start_time is the field for the start time of the event.
+
+CSS
+---
+
+You will probably want to customize the height of the calendar so that
+all the rows are the same. You can do this by adding the following line
+to your css:
+
+ .calendar td { height: 100px; width: 14.28%; }
+
+By default simple_calendar will set the calendar to use .bordered-table
+and .calendar classes.
+
+TODO
+====
+
+* Add query helpers to grab events for a current month and the days into
+ the next and previous months for efficiency
+* Customizable starting day of week
+* More customization?