README.md in typogruby-1.0.2 vs README.md in typogruby-1.0.3

- old
+ new

@@ -2,11 +2,11 @@ Helps you improve your web typograpbhy with some standard text filters. This project is based on Django's Typogrify, so the best introduction to read would be [Jeff Croft's][1]. -I created this gem to easily share these text filters in some tiny Ruby projects, including a TextMate bundle. For production code I recommend checking out the originals first. +I created this gem to easily share these text filters in some tiny Ruby projects, including [a TextMate bundle][5]. For production code I recommend checking out the originals first. ## General Usage First, install the Ruby gem: @@ -21,18 +21,47 @@ require 'typogruby' include Typogruby improve('Hello, world!') +See the [full API documentation][4] for more information. You could also use [this Textmate Bundle][5]. + +## From the command line + +You can also use typogruby directly from the command line: + + typogruby MY_FILE + +This will output the contents of your file with all filters applied. Use `typogruby -h` for more information and options. + ## References * Based on [typography-helper][2] * ...and on [Typogrify][3] * [Description of typogrify][1] [1]: http://jeffcroft.com/blog/2007/may/29/typogrify-easily-produce-web-typography-doesnt-suc/ [2]: http://github.com/hunter/typography-helper [3]: http://code.google.com/p/typogrify +[4]: http://avdgaag.github.com/typogruby +[5]: http://github.com/avdgaag/Typography-tmbundle + +## Changelog + +### 1.0.3 + +* Bugfix: caps also ignores unequal but same excepted tags +* Feature: added command-line program +* Improved documentation + +### 1.0.2 + +* Bugfix: initial_quotes also wraps named HTML entities +* Bugfix: caps no longer wraps consecutive numbers + +### 1.0 + +* First release ## Note on Patches/Pull Requests * Fork the project. * Make your feature addition or bug fix.