Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 46 lines (26 sloc) 2.107 kB
3d6f20d @julien51 Initial commit to rack-superfeedr.
julien51 authored
1 = rack-superfeedr
2
bf1be8f @julien51 improved docs
julien51 authored
3 A gem that provides a rack middleware to interact with {Superfeedr}[http://superfeedr.com/]'s PubSubHubbub API. It let you *subscribe*, *unsubscribe* and *receive* incoming feed notifications.
843256c @julien51 yet more docs
julien51 authored
4 This should work with any Rack-compatible framework, as well as fully managed platforms like {Heroku}[http://www.heroku.com/].
757ac35 @julien51 updated docs
julien51 authored
5
6 == Installing
7
843256c @julien51 yet more docs
julien51 authored
8 gem install rack-superfeedr
757ac35 @julien51 updated docs
julien51 authored
9
10 == Using
11
49062a3 @julien51 Improved docs
julien51 authored
12 You first need a {subscriber account}[http://superfeedr.com/subscriber] with Superfeedr.
13
14 *Warning* : your web application needs to be accessible for Superfeedr to send notifications. If you want to test it locally, we suggest you use it with a tool like {showoff}[https://showoff.io/] which will make your local port accessible from the outside world.
15
16 === Sinatra
843256c @julien51 yet more docs
julien51 authored
17
757ac35 @julien51 updated docs
julien51 authored
18 See the {example}[https://github.com/superfeedr/rack-superfeedr/blob/master/examples/sinatra_app.rb]... and {check the docs}[http://rubydoc.info/github/superfeedr/rack-superfeedr/master/Rack/Superfeedr] for more details.
3d6f20d @julien51 Initial commit to rack-superfeedr.
julien51 authored
19
49062a3 @julien51 Improved docs
julien51 authored
20 === Rails
21
22 Tested with Rails 3.2, but should work with any Rails version that supports Rack.
23
86ed0bc @julien51 updated docs
julien51 authored
24 Install the gem (using bundle), and then in <code>config/application.rb</code>, inside the <code>class Application < Rails::Application</code> block, just add the following line.
49062a3 @julien51 Improved docs
julien51 authored
25
26 config.middleware.use Rack::Superfeedr, { :host => DOMAIN, :login => SUPERFEEDR_LOGIN, :password => SUPERFEEDR_PASSWORD} do |superfeedr|
27 Superfeedr = superfeedr
28 end
29
0dbe5c5 @julien51 improved docs
julien51 authored
30 You can then access the Superfeedr object anywhere in your rails application with <code>YOUR_APP::Application::Superfeedr</code>.
49062a3 @julien51 Improved docs
julien51 authored
31
843256c @julien51 yet more docs
julien51 authored
32
81a9904 @julien51 docs improved, example clarified
julien51 authored
33 == Contributing
3d6f20d @julien51 Initial commit to rack-superfeedr.
julien51 authored
34
35 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
36 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
37 * Fork the project
38 * Start a feature/bugfix branch
39 * Commit and push until you are happy with your contribution
40 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
41
42 == Copyright
43
81a9904 @julien51 docs improved, example clarified
julien51 authored
44 Copyright (c) 2012 Superfeedr. See LICENSE.txt for further details.
3d6f20d @julien51 Initial commit to rack-superfeedr.
julien51 authored
45
Something went wrong with that request. Please try again.