1
0
Fork 0
mirror of https://github.com/awesome-print/awesome_print synced 2023-03-27 23:22:34 -04:00

Updated README and CHANGELOG files

This commit is contained in:
Mike Dvorkin 2011-11-29 20:26:00 -08:00
parent c96c2c6541
commit 32e76633e8
3 changed files with 23 additions and 12 deletions

View file

@ -1,6 +1,10 @@
?.?.?
- Added ability to format *arbitrary* Ruby object
- Added :limit option to limit large output for arrays and hashes (Andrew Horsman)
- Improved HTML formatting when :html => true (Daniel Johnson)
- Added Mongoid extension (Adam Doppelt)
- Added Nokogiri extension (Adam Doppelt)
- Removed Jeweler gem dependency
0.4.0
- 'ap object' now returns the object (Stephan Hagemann)

View file

@ -1,5 +1,5 @@
## Awesome Print ##
Awesome Print is Ruby library that pretty prints Ruby objects in full color
Awesome Print is a Ruby library that pretty prints Ruby objects in full color
exposing their internal structure with proper indentation. Rails ActiveRecord
objects and usage within Rails templates are supported via included mixins.
@ -7,9 +7,6 @@ objects and usage within Rails templates are supported via included mixins.
# Installing as Ruby gem
$ gem install awesome_print
# Installing as Rails plugin
$ ruby script/plugin install http://github.com/michaeldv/awesome_print.git
# Cloning the repository
$ git clone git://github.com/michaeldv/awesome_print.git
@ -28,19 +25,24 @@ Default options:
:sort_keys => false, # Do not sort hash keys.
:limit => false, # Limit large output for arrays and hashes. Set to a boolean or integer.
:color => {
:args => :pale,
:array => :white,
:bignum => :blue,
:bigdecimal => :blue,
:class => :yellow,
:date => :greenish,
:falseclass => :red,
:fixnum => :blue,
:float => :blue,
:hash => :gray,
:hash => :pale,
:keyword => :cyan,
:method => :purpleish,
:nilclass => :red,
:string => :yellowish,
:struct => :pale,
:symbol => :cyanish,
:time => :greenish,
:trueclass => :green
:trueclass => :green,
:variable => :cyanish
}
Supported color names:
@ -300,12 +302,17 @@ For example:
### Contributors ###
* Adam Doppelt -- https://github.com/gurgeous
* Andrew O'Brien -- https://github.com/AndrewO
* Andrew Horsman -- https://github.com/basicxman
* Benoit Daloze -- http://github.com/eregon
* Brandon Zylstra -- https://github.com/brandondrew
* Daniel Johnson -- https://github.com/adhd360
* Daniel Bretoi -- http://github.com/danielb2
* Eloy Duran -- http://github.com/alloy
* Elpizo Choi -- https://github.com/fuJiin
* Benoit Daloze -- http://github.com/eregon
* Greg Weber -- https://github.com/gregwebs
* Jeff Felchner -- https://github.com/jfelchner
* Sean Gallagher -- http://github.com/torandu
* Stephan Hagemann -- https://github.com/shageman
* Tim Harper -- http://github.com/timcharper

View file

@ -31,6 +31,7 @@ module AwesomePrint
:sort_keys => false, # Do not sort hash keys.
:limit => false, # Limit large output for arrays and hashes. Set to a boolean or integer.
:color => {
:args => :pale,
:array => :white,
:bigdecimal => :blue,
:class => :yellow,
@ -39,15 +40,14 @@ module AwesomePrint
:fixnum => :blue,
:float => :blue,
:hash => :pale,
:struct => :pale,
:keyword => :cyan,
:method => :purpleish,
:nilclass => :red,
:string => :yellowish,
:struct => :pale,
:symbol => :cyanish,
:time => :greenish,
:trueclass => :green,
:method => :purpleish,
:args => :pale,
:keyword => :cyan,
:variable => :cyanish
}
}