README.rdoc in timepiece-0.1.3 vs README.rdoc in timepiece-0.1.4
- old
+ new
@@ -22,32 +22,32 @@
* Pass a timezone paramater (Defaults to 'UTC')
<%= timepiece('London') %>
-* Show a 12 hour clock by specifying it explicitly
+* Show a 12 hour clock by specifying its `type:` explicitly
- <%= timepiece('London', '12') %>
+ <%= timepiece('London', type: '12') %>
-By default the 12 hour clock displays time without any leading character, in the format '1:23pm'. You can add either a zero, as present on the 24 hour clock, or a leading space character the size of a numerical digit - useful for keeping your clocks aligned.
+By default the 12 hour clock displays time without any leading character, in the format '1:23pm'. You can add either a zero, as present on the 24 hour clock, or a leading space character the size of a numerical digit - useful for keeping your clocks aligned. To achieve this, set the Timepiece's `lead:`
* To add a leading zero to hour values less than ten
- <%= timepiece('London', '12', '0') %>
+ <%= timepiece('London', lead: '0') %>
or
- <%= timepiece('London', '12', 'zero') %>
+ <%= timepiece('London', lead: 'zero') %>
* To add a space character
- <%= timepiece('London', '12', '_') %>
+ <%= timepiece('London', lead: '_') %>
or
- <%= timepiece('London', '12', 'space') %>
+ <%= timepiece('London', lead: 'space') %>
-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 in the options.
+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', '12', '0', '.') %>
+ <%= timepiece('London', abbr_sep: '.') %>