README.rdoc in timepiece-0.1.7 vs README.rdoc in timepiece-0.1.8
- old
+ new
@@ -12,10 +12,12 @@
2. Require timepiece in app/assets/javascripts/application.js
//= require 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
<%= timepiece %>
@@ -51,5 +53,13 @@
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: '.') %>
+
+== 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.
+
+* The helper also takes a time object as a parameter, for example:
+
+ <%= timer(User.first.created_at) %>