Permalink
Browse files

Update description and README

  • Loading branch information...
1 parent 46b746b commit 5a70a8f61e624b2190f438af78a3d3b22c39b8a8 @vanstee committed Jul 2, 2012
Showing with 19 additions and 14 deletions.
  1. +13 −12 README.md
  2. +6 −2 hovercraft.gemspec
View
@@ -1,26 +1,27 @@
# Hovercraft
-TODO: Write a gem description
+Generate a RESTful API from a directory of ActiveRecord models.
-## Installation
+## Get Up and Running
-Add this line to your application's Gemfile:
+1. Throw this in your Gemfile:
- gem 'hovercraft'
+ `gem 'hovercraft'`
-And then execute:
+2. Put your ActiveRecord models in `models/` (make sure the file names
+ are the same as the class names).
- $ bundle
+3. Create a rackup file that generates the application:
-Or install it yourself as:
+ ```ruby
+ run Hovercraft::Server.new
+ ```
- $ gem install hovercraft
+4. Run the application like normal:
-## Usage
+ `bundle exec rackup`
-TODO: Write usage instructions here
-
-## Contributing
+## Give Back
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
View
@@ -4,8 +4,12 @@ require File.expand_path('../lib/hovercraft/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ['vanstee']
gem.email = ['vanstee@highgroove.com']
- gem.description = %q{TODO: Write a gem description}
- gem.summary = %q{TODO: Write a gem summary}
+ gem.description = %q{Generate a RESTful API from a directory of ActiveRecord models}
+ gem.summary = %q{There's a lot of boiler plate code that goes into
+ creating an API so why not just generate all that code
+ from the models. Just throw your models in a models
+ directory and call the server from the rackup file and
+ you have yourself a perfect API.}
gem.homepage = ''
gem.files = `git ls-files`.split("\n")

0 comments on commit 5a70a8f

Please sign in to comment.