Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
lackac committed Jun 15, 2011
1 parent 54d4404 commit 6f5a6bc
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
@@ -1,15 +1,34 @@
# Omnicat

Ever find you have to look at a repository on GitHub you know the name of but not the owner? You go to [github.com](https://github.com) or you may already have a search keyword for GitHub in your browser, you enter the name of the repository, wait a few seconds and then try to identify the repository you're looking for in the search results.

This can be easier and quicker. Install this chrome extension and start typing `gh<tab>` in Omnibox (the location bar). Anything you type after this will be autocompleted to GitHub repositories by owner and/or name. The repositories are ordered by the number of watchers and you can even see their descriptions right on the spot. Choose the one you're looking for and you'll be on the page of the repository in no time.
Ever find you have to look at a repository on GitHub you know the name
of but not the owner? You go to [github.com](https://github.com) or you
may already have a search keyword for GitHub in your browser, you enter
the name of the repository, wait a few seconds and then try to identify
the repository you're looking for in the search results.

This can be easier and quicker. Install this chrome extension and start
typing `gh<tab>` in Omnibox (the location bar). Anything you type after
this will be autocompleted to GitHub repositories by owner and/or name.
The repositories are ordered by the number of watchers and you can even
see their descriptions right on the spot. Choose the one you're looking
for and you'll be on the page of the repository in no time.

You can even search for your own public and private repositories by
entering your GitHub username and token on the options page of the
extension. Organization repositories you have access to will be included
as well. These repositories will show up at the top of the suggestions.

Much quicker and easier, isn't it? Now go and contribute to open source!

# Installation

Through [Chrome Web Store](https://chrome.google.com/webstore/developer/detail/hljoheoboihichiahhbkahljbbbjpigg)

# Development

The extension is written in JavaScript for Google Chrome. You won't need
anything except for the browser for development.
anything except the browser if you don't want to change database related
stuff.

Support codes are written in CoffeeScript with Node.js. You will need to
install [coffee-script](https://github.com/jashkenas/coffee-script) and
Expand All @@ -22,7 +41,9 @@ npm install -g coffee-script jake
Every other dependencies are already included under `node_modules/`.

Oh, an you'll also need [CouchDB](http://couchdb.apache.org/) if you want
to poke around the views and repo documents.
to poke around the views and repo documents. Go to [Cloudant](https://cloudant.com/)
to get a free account for development if you don't want to install it on
your machine.

# Note on Patches/Pull Requests

Expand Down

0 comments on commit 6f5a6bc

Please sign in to comment.