Permalink
Browse files

update readme + changelog, tweak description

  • Loading branch information...
1 parent 63f50f7 commit eede13b7404da50a399058423c27a83f9eee1626 @cldwalker committed Jan 7, 2011
Showing with 16 additions and 9 deletions.
  1. +1 −1 .gemspec
  2. +3 −0 CHANGELOG.rdoc
  3. +12 −8 README.rdoc
View
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
s.email = "gabriel.horner@gmail.com"
s.homepage = "http://tagaholic.me/bond/"
s.summary = "Mission: Easy custom autocompletion for arguments, methods and beyond. Accomplished for irb and any other readline-like console environments."
- s.description = "Bond is on a mission to improve irb's autocompletion. Aside from doing everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings irb's completion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions and completion rules. With this configuration system, users can customize their irb autocompletions and share it with others. Bond can also generate completions from yard documentation and load completions that ship with gems. Bond is able to offer more than irb's completion since it uses a Readline C extension to get the full line of input when completing as opposed to irb's last-word approach."
+ s.description = "Bond is on a mission to improve autocompletion in ruby, especially for irb. Aside from doing everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings irb's completion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions and completion rules. With this configuration system, users can customize their irb autocompletions and share it with others. Bond can also load completions that ship with gems. Bond is able to offer more than irb's completion since it uses a Readline C extension to get the full line of input when completing as opposed to irb's last-word approach."
s.required_rubygems_version = ">= 1.3.6"
s.rubyforge_project = 'tagaholic'
s.has_rdoc = 'yard'
View
@@ -1,3 +1,6 @@
+== 0.3.5
+* Move yard-related functionality to bond-yard gem
+
== 0.3.4
* Add gem plugin completion
* Add jruby support thanks to @headius
View
@@ -2,13 +2,14 @@ Note: To read a linked version of this README, {click here}[http://tagaholic.me/
== Description
-Bond is on a mission to improve irb's autocompletion. Aside from doing everything irb's can do and fixing its quirks,
-Bond can autocomplete argument(s) to methods, uniquely completing per module, per method and per argument. Bond brings
-irb's completion closer to bash/zsh as it provides a configuration system and a DSL for creating custom completions
-and completion rules. With this configuration system, users can customize their irb autocompletions and share
-it with others. Bond can also load completions that ship with gems. Bond is able to offer more than
-irb's completion since it uses a Readline C extension to get the full line of input when completing
-as opposed to irb's last-word approach.
+Bond is on a mission to improve autocompletion in ruby, especially for irb. Aside from doing
+everything irb's can do and fixing its quirks, Bond can autocomplete argument(s) to methods,
+uniquely completing per module, per method and per argument. Bond brings irb's completion closer to
+bash/zsh as it provides a configuration system and a DSL for creating custom completions and
+completion rules. With this configuration system, users can customize their irb autocompletions and
+share it with others. Bond can also load completions that ship with gems. Bond is able to offer
+more than irb's completion since it uses a Readline C extension to get the full line of input when
+completing as opposed to irb's last-word approach.
== Install
@@ -23,14 +24,16 @@ To start off, replace irb's completion (require 'irb/completion') with Bond's en
require 'bond'
Bond.start
+If you're using {ripl}[http://github.com/cldwalker/ripl], bond is used by default.
+
This gives you more consistent method completion on any object, customizable completions
and argument completion of some 80+ methods including Hash#[], Kernel#system, Kernel#require and some Rails methods.
== Method Argument Completion
By default, Bond autocompletes arguments for a number of core methods:
- $ irb
+ $ ripl
# require completes gems and anything in $LOAD_PATH
>> require 'rb[TAB]
rbconfig.rb rbconfig/
@@ -151,6 +154,7 @@ There are a number of incorrect completions irb gives for object methods. Bond f
Irb completes anything surrounded with '{}' the same:
+ $ irb
>> proc {}.c[TAB]
}.call }.class }.clear }.clone }.collect
>> %w{ab bc}.c[TAB]

0 comments on commit eede13b

Please sign in to comment.