Permalink
Browse files

Add README

  • Loading branch information...
Gareth Rees Gareth Rees
Gareth Rees authored and Gareth Rees committed Sep 20, 2011
1 parent 169203a commit 2545c12b9a2135908b79be4cbd8cf2d39ac4b982
Showing with 21 additions and 0 deletions.
  1. +21 −0 README
View
21 README
@@ -0,0 +1,21 @@
+# Estimate Reading Time
+
+I use [iA Writer](http://iawriter.com "iA Writer") and find the *estimated reading time* feature pretty handy. I thought it would be cool to add at the top of my blog articles on the web as [others](http://nicepaul.com "The personal blog of @nicepaul") do.
+
+Full credit goes to [Brian Cray](http://briancray.com/2010/04/09/estimated-reading-time-web-design "Brian Cray - Estimated Reading Time in Web Design") for explaining how to do it in PHP.
+
+## How to Use
+
+[readingtime](http://github.com/garethrees/readingtime "Gem to estimate reading time") extends the Ruby String class, so you can call `reading_time` on any string object.
+
+### Example
+
+ @words = "Lorem ipsum dolor sit amet"
+ @words.reading_time
+ => "0:1"
+
+
+## Bugs
+
+* As in the example, second ranges under ten seconds are formatted as `0:1` instead of `0:01`
+* Ideally, `reading_time` should return a `Time` object so it can be formatted with `strftime`

0 comments on commit 2545c12

Please sign in to comment.