README.rdoc in timepiece-0.2.1 vs README.rdoc in timepiece-0.2.2
- old
+ new
@@ -12,10 +12,18 @@
2. Require timepiece in app/assets/javascripts/application.js
//= require timepiece
+3. If you want to use the new analog clock, you also need to require timepiece in your css
+
+ *= require 'timepiece'
+
+ or if you're using SCSS
+
+ @import 'timepiece';
+
Note: If you're using Turbolinks with your Rails project, you should also install jquery-turbolinks to ensure functionality is maintained between page loads.
== Usage
* Add a functional clock to your views
@@ -53,9 +61,24 @@
You can apply your own styles to any part of the Timepiece clock. For instance, you can capitalize the AM/PM abbreviation by targeting the span with class 'timepiece-abbr'. By default, the abbreviations are displayed without punctuation. To add punctuation, you can specify it with the `abbr_sep:` option.
* Add punctuation to am/pm abbreviation
<%= timepiece('London', type: '12', abbr_sep: '.') %>
+
+
+== Analog
+
+New to version 0.2.0+, you can now include analog clocks in your projects.
+
+* The helper takes the same timezone parameter as the digital version (defaults to 'UTC'):
+
+ <%= analog('London') %>
+
+* To specify a certain size for the clock, use the `size` parameter (defaults to 10em):
+
+ <%= analog('London', :size => '100px') %>
+
+ Note that if you pass a percentage, the size will be set as a percentage of the containing div.
== Timer
It is now also possible to make use of a basic timer. To start a count from `Time.now`, simply include `timer` in your Rails projects.