Skip to content

Commit

Permalink
Make readme purdy
Browse files Browse the repository at this point in the history
  • Loading branch information
radar committed Jan 24, 2009
1 parent 09d3914 commit 1ff2aad
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 24 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Lazy Man's ri (lookup)

## Example usage:

* `lookup ActiveRecord::Base#new` (returns a single method, since the method name is right)
* `lookup ActiveRecord::Base#destroy` (returns two methods, since there's two methods with that name)
* `lookup ActiveRecord::Base#destro` (returns three methods, uses methods beginning with "destroy")
* `lookup ActiveRecord::Base#d` (tells you to be more specific, because it can't open 35 tabs at once)
* `lookup ActiveRecord::Base` (returns a single consant)
* `lookup Acv::Base` (returns six constants, because it does a fuzzy match)



## How it finds them
1. Checks if there's constants/methods with that exact name.
2. Checks if there's constants/methods with names beginning with that name.
3. Does a "fuzzy match" splitting the name and getting anything containing those letters in that order.
4. Opens your browser if you're running a DECENT_OPERATING_SYSTEM (may add support for things other than Mac later on)
5. ???
6. Profit
20 changes: 0 additions & 20 deletions README.rdoc

This file was deleted.

4 changes: 2 additions & 2 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ spec = Gem::Specification.new do |s|
s.version = GEM_VERSION
s.platform = Gem::Platform::RUBY
s.has_rdoc = true
s.extra_rdoc_files = ["README.rdoc", "LICENSE", 'TODO']
s.extra_rdoc_files = ["README.md", "LICENSE", 'TODO']
s.summary = SUMMARY
s.description = s.summary
s.author = AUTHOR
Expand All @@ -29,7 +29,7 @@ spec = Gem::Specification.new do |s|

s.require_path = 'lib'
s.autorequire = GEM
s.files = %w(LICENSE README.rdoc Rakefile TODO) + Dir.glob("{lib,spec,bin}/**/*")
s.files = %w(LICENSE README.md Rakefile TODO) + Dir.glob("{lib,spec,bin}/**/*")
end

task :default => :spec
Expand Down
4 changes: 2 additions & 2 deletions lookup.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Gem::Specification.new do |s|
s.description = %q{A gem that provides a lazy man's ri}
s.email = %q{radarlistener@gmail.com}
s.executables = ["lookup"]
s.extra_rdoc_files = ["README.rdoc", "LICENSE", "TODO"]
s.files = ["LICENSE", "README.rdoc", "Rakefile", "TODO", "lib/classes", "lib/config.rb", "lib/lookup.rb", "lib/methods", "spec/lookup_spec.rb", "spec/spec_helper.rb", "bin/lookup"]
s.extra_rdoc_files = ["README.md", "LICENSE", "TODO"]
s.files = ["LICENSE", "README.md", "Rakefile", "TODO", "lib/classes", "lib/config.rb", "lib/lookup.rb", "lib/methods", "spec/lookup_spec.rb", "spec/spec_helper.rb", "bin/lookup"]
s.has_rdoc = true
s.homepage = %q{http://gitpilot.com}
s.require_paths = ["lib"]
Expand Down

0 comments on commit 1ff2aad

Please sign in to comment.