From 4bb4c628bd1afcaaa6cf13d20b4aff2dd17885fc Mon Sep 17 00:00:00 2001 From: Carl Tashian Date: Mon, 10 May 2010 16:40:52 -0700 Subject: [PATCH] Updated readme --- README.markdown | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.markdown b/README.markdown index f972728..b16728e 100644 --- a/README.markdown +++ b/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 ./script/generate govkit to copy a config file into config/initializers/govkit.rb. 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.