markdown/readme/template.md in minitest_lucid-0.1.0 vs markdown/readme/template.md in minitest_lucid-1.0.0
- old
+ new
@@ -1,10 +1,41 @@
# Minitest Lucid
-Use ```minitest_lucid``` to improve error messages from ```minitest```.
+Use ```minitest_lucid``` to improve assertion messages from ```minitest```.
+## Usage
+To use ```minitest_lucid```, install the gem and then in your tests,
+
+```ruby
+require 'minitest_lucid'
+```
+
+instead of
+
+```ruby
+require 'minitest/autorun'
+```
+
+No other code change is required.
+
+For example, change this test
+
+@[ruby](not_lucid.rb)
+
+to this
+
+@[ruby](lucid.rb)
+
+See example outputs below.
+
## Supported Classes
+
+For supported classes, method ```assert_equal``` gets elucidated handling.
+
+For other classes and assertion methods, the original assertion behaviors are unchanged.
+
+The supported classes:
- [Hash](#hash)
- [Set](#set)
- [Struct](#struct)