Extra cool IRb goodness for the masses.
Ruby

README

= brice - Extra cool IRb goodness for the masses

== VERSION

This documentation refers to brice version 0.4.1


== DESCRIPTION

Enhances your IRb experience by adding new functionality and by
providing a framework that you can utilize to add your own extensions.
It comes with a set of pre-selected features (see the files in
{lib/brice/rc}[link:../lib/brice/rc]), but is highly configurable
in that regard.

Add this to your <tt>~/.irbrc</tt> and receive the default goodness:

  require 'brice/init'  # equivalent to: require 'brice'; Brice.init

Or get some more control over the configuration:

  require 'brice'

  Brice.init { |config|
    ...
  }

See Brice::Config for what you can configure, and how.

It will even load your own extensions that you place in your <tt>~/.brice</tt>
directory. See Brice::DSL for helpers provided.

Please note that further changes to the configuration for brice can't be
guaranteed to have any effect after <tt>Brice.init</tt> has been called.


== DEFAULT FEATURES

+added_methods+:: Loads AddedMethods[http://blackwinter.github.com/added_methods]
                  if one (or both) of the following environment variables has
                  been set:

                  +WATCH_FOR_ADDED_METHODS+::    Regular expression or +true+
                  +WATCH_FOR_ADDED_METHODS_IN+:: Space- or comma-delimited list of class names
+libs+::          Loads libraries, either a set of default ones or those you
                  configure with <tt>config.libs = %w[...]</tt>.
+history+::       Configures IRb history support. See Brice::History for more
                  information.
+colours+::       Configures IRb colour support. See Brice::Colours for more
                  information.
+shortcuts+::     Includes convenient shortcut methods. See Brice::Shortcuts
                  and Brice::Shortcuts::ObjectShortcuts for more information.
+init+::          Does some basic initialization for IRb.
+prompt+::        Configures the IRb prompt, providing <tt>:BRICE_SIMPLE</tt>
                  and <tt>:BRICE_VERBOSE</tt> prompt modes.
+rails+::         Provides some Rails settings, such as adding the
                  <tt>:BRICE_RAILS</tt> prompt mode, setting the Rails logger
                  to +STDOUT+, and defining convenience accessors for your
                  models.
+devel+::         Provides some useful settings when developing Ruby libraries.


== LINKS

Documentation:: https://blackwinter.github.com/brice
Source code::   https://github.com/blackwinter/brice
RubyGem::       https://rubygems.org/gems/brice
Travis CI::     https://travis-ci.org/blackwinter/brice


== AUTHORS

* Jens Wille <mailto:jens.wille@gmail.com>


== LICENSE AND COPYRIGHT

Copyright (C) 2008-2016 Jens Wille

brice is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option)
any later version.

brice is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.

You should have received a copy of the GNU Affero General Public License
along with brice. If not, see <http://www.gnu.org/licenses/>.