Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Carl Tashian committed May 10, 2010
1 parent d174e46 commit 4bb4c62
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.markdown
@@ -1,33 +1,28 @@
Govkit
======
# Govkit

Govkit is a Ruby gem that provides simple access to open government APIs around the web.

Installation
============
# Installation

From gemcutter:

gem install govkit
gem install govkit

Setup
=====
# Setup

Add govkit to your environment.rb or Gemfile

Run <code>./script/generate govkit</code> to copy a config file into <code>config/initializers/govkit.rb</code>. You will need to add your API keys to this config file.

Example
=======
# Example

[http://fiftystates-dev.sunlightlabs.com/](The Fifty States project) has a RESTful API for accessing data about state legislators, bills, votes, etc.

>> Govkit::FiftyStates::State.find_by_abbrev('CA')
>> Govkit::FiftyStates::State.find_by_abbrev('CA')

(TODO: add usage examples...)

Bugs? Questions?
================
# Bugs? Questions?

Please join the [Govkit Google Group](http://groups.google.com/group/govkit), especially if you'd like to talk about a new feature and get announcements.

Expand Down

0 comments on commit 4bb4c62

Please sign in to comment.