Skip to content
Browse files

README added

  • Loading branch information...
1 parent 377d667 commit 75cd17de34237460b3af0b01424d1bd91a86a569 @dotemacs committed Feb 22, 2014
Showing with 23 additions and 0 deletions.
  1. +23 −0 README.md
View
23 README.md
@@ -0,0 +1,23 @@
+# Omniref
+
+Emacs interface for Ruby documentation search engine
+[http://www.omniref.com/](http://www.omniref.com/)
+
+## Usage
+
+When you want to look up a certain term in Ruby documentation, just run
+
+<kbd>M-x omniref</kbd>
+
+if you've selected a region of a buffer, a new page will open in your
+browser with the search term. Otherwise you'll be prompted for a term
+you wish to search for.
+
+## Key binding
+
+If you find yourself using **omniref** a lot, maybe you'd like to bind
+it to something like:
+
+```el
+(define-key ruby-mode-map (kbd "C-c o") 'omniref)
+```

0 comments on commit 75cd17d

Please sign in to comment.
Something went wrong with that request. Please try again.