Skip to content
Browse files

adding a few docs

  • Loading branch information...
1 parent eac3d7c commit 51a68fa3fea71edd2d4993e44344026342b6611d @atmos committed Jun 1, 2010
Showing with 8 additions and 4 deletions.
  1. +8 −4 README.md
View
12 README.md
@@ -1,10 +1,14 @@
sinatra_auth_github
===================
-A sinatra app the provides a gem that...
+A sinatra extension that provides oauth authentication to github. Find out more about enabling your application at github's [oauth quickstart](http://gist.github.com/419219).
-Developing
-==========
+To test it out on localhost set your callback url to 'http://localhost:9292/auth/github/callback'
+
+There's an example app in [spec/app.rb](/spec/app.rb).
+
+The Extension in Action
+=======================
% gem install bundler
% bundle install
- % bundle exec rake
+ % GH_CLIENT_ID="<from GH>" GH_SECRET="<from GH>" bundle exec rackup

0 comments on commit 51a68fa

Please sign in to comment.
Something went wrong with that request. Please try again.