# Github-Search

  A [node.js](http://nodejs.org/) wrapper for [Github's Search REST API](http://developer.github.com/v3/search/).

## Installation

  Install using the node.js package manager [npm](http://npmjs.org/):

      $ npm install github-search
      
  Or...

  Install via git clone:

      $ git clone git://github.com/KevinTCoughlin/node-github-search.git
      $ cd node-github-search
      $ npm install

## Requirements

  You can install github-search and its dependencies with npm: 
    
      $ npm install github-search
  
  Dependencies
  
  * [Node.js](http://nodejs.org/) v0.8 +

## Examples

  Demos of the github-search module are located in [/examples](https://github.com/KevinTCoughlin/node-github-search/tree/master/example)
  
## API Documentation


## Example Usage


## Testing

  Issue the following Make command in the top directory to run the mocha.js test cases:
  
      $ make test

## LICENSE

  Github-Search: Copyright (c) 2013 Kevin Coughlin
  
  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:
  
  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.