README.md in cute_print-0.1.0 vs README.md in cute_print-0.2.0
- old
+ new
@@ -1,16 +1,24 @@
# cute_print
+[](http://badge.fury.io/rb/cute_print)
+[](https://gemnasium.com/wconrad/cute_print)
+[](https://travis-ci.org/wconrad/cute_print)
+[](https://codeclimate.com/github/wconrad/cute_print)
-Write debug output to the console, with flair. Features:
+Write debug output to stderr. Optionally print the source filename
+and line number, or the source of the debug statement. Easily debug
+the middle of a call chain.
-* Inspects its output, like Kernel#p
-* Writes to $stderr by default (good when $stdout is redirected)
-* Can print the filename and line number
-* Can print the source of the value
-* Can print a value in the middle of a call chain
-* Configurable output device
+## Features
+* Inspects its output, like Kernel#p.
+* Writes to $stderr by default (good when $stdout is redirected).
+* Can print the filename and line number.
+* Can print the source of the value.
+* Can print a value in the middle of a call chain.
+* Configurable output device.
+
This is for those who prefer to debug by writing things to the
console.
## Installation
@@ -41,15 +49,19 @@
You can have the debug source printed along with the value:
i = 1
q {i + 2} # i + 2 is 3
-Kernel#ql will add the source position:
+Kernel#ql will add the source location:
ql "abc" # foo.rb:12: "abc"
ql {1 + 2} # foo.rb:13: 1 + 2 is 3
+When called with no arguments, #ql just prints the source location:
+
+ ql # foo.rb:14
+
Call chains can be a pain to debug, but it's easy with Kernel#tapq and
Kernel#tapql:
["1", "2"].map(&:to_i).tapq.inject(&:+)
# [1, 2]
@@ -57,18 +69,19 @@
["1", "2"].map(&:to_i).tapql.inject(&:+)
# prints: bar.rb:12: [1, 2]
## Documentation
-[Full documentation (relishapp)][2]
+There's more. Please see the [Full documentation][2] (relishapp).
## Rubies supported
This gem is known to work with these Rubies:
-* ruby-1.9.3
-* ruby-2.1.2
+* ruby-1.9.3-p547
+* ruby-2.0.0-p481
+* ruby-2.1.2p95
## Platforms supported
This gem is developed and tested with Linux. It should work on
Windows and OSX as well. If it does not work for you, please file an
@@ -80,13 +93,19 @@
much like this gem's #q method. This gem's ability to read the debug
statement's source is derived from the _wrong_ gem.
Differences between the _wrong_ gem and this gem:
+* This gem can print the source location
+* This gem writes to $stderr
+* This gem's output is configurable
+* This gem requires Ruby >= 1.9
+* This gem debugs call chains
* The _wrong_ gem supports color output
-* The _wrong_ gem writes only to stdout
+* The _wrong_ gem writes to stdout
* The _wrong_ gem supports Ruby 1.8
+* The _wrong_ gem has assertions and more
## Versioning
This gem uses [semantic versioning 2.0][3].
@@ -103,7 +122,7 @@
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
[1]: http://rubygems.org/gems/wrong
-[2]: https://www.relishapp.com/wconrad/cute-print/docs
+[2]: https://www.relishapp.com/wconrad/cute-print/v/0-2-0/docs
[3]: http://semver.org/spec/v2.0.0.html