Skip to content

Commit

Permalink
Cleaning up the README a bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Bleigh committed Nov 14, 2010
1 parent 01676ed commit e690f37
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 64 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2009 Michael Bleigh
Copyright (c) 2010 Michael Bleigh and Intridea, Inc.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
35 changes: 24 additions & 11 deletions README.markdown
Expand Up @@ -19,44 +19,57 @@ Grape APIs are Rack applications that are created by subclassing `Grape::API`. B
def current_user
@current_user ||= User.authorize!(env)
end
def authenticate!
error!('401 Unauthorized', 401) unless current_user
end
end
resource :statuses do
formats :rss, :atom
get :public_timeline do
Tweet.limit(20)
end
get :home_timeline do
authenticate!
current_user.home_timeline
end
get '/show/:id' do
Tweet.find(params[:id])
end
post :update do
authenticate!
Tweet.create(
:user => current_user,
:text => params[:status]
)
end
end
end

# Rack endpoint
Twitter::API.statuses.timelines.get(:public_timeline)
This would create a Rack application that could be used like so (in a Rackup file):

use Twitter::API

class Twitter::API::User < Grape::Resource::ActiveRecord
represents ::User
property :status, lambda{|u| u.latest_status}, Twitter::API::Status
end
And would respond to the following routes:

GET /1/statuses/public_timeline(.json)
GET /1/statuses/home_timeline(.json)
GET /1/statuses/show/:id(.json)
POST /1/statuses/update(.json)

Serialization takes place automatically. For more detailed usage information, please visit the [Grape Wiki](http://github.com/intridea/grape/wiki).

== Note on Patches/Pull Requests
## Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a future version unintentionally.
* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Copyright
## Copyright

Copyright (c) 2010 Michael Bleigh and Intridea, Inc. See LICENSE for details.
52 changes: 0 additions & 52 deletions README.rdoc

This file was deleted.

0 comments on commit e690f37

Please sign in to comment.