• Stars
    star
    164
  • Rank 228,730 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 12 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A universal Subscribe/Follow button.

Subscribe Button

SubToMe is a universal subscribe button. It decouples the content to which a user can subscribe from the application this user may want to use to perform the subscription. It's loosely inspired by WebIntents.

The spec is the code, and the code is open source. Feel free to contribute to it. You could very well run your own instance, but that means users may have to reselect their favorite subscription tool over and over again.

By design, all state is kept in the user's browser, using localStorage.

This is intended to be run as a bookmarklet or an embedded button on any web page.

Workflow.

  1. A user visits a site that is able to provide some kind of subscription mechanism. That web application will then embed in its page some code that will register this application on behalf of the user.

  2. The subscription button script will store in the user's session the fact that he can use the previously described app for subscriptions.

  3. Later, when on another site which publishes content, the user wants to follow a given resource and clicks on the bookmarklet.

  4. The user is then showed the list of services that may be able to handle his subscription.

  5. Once the user picks a service, he's sent to that service to complete the subscription.

Check Also

Ant0ine very kindly contributed a SubToMe Chrome Extension (Google removed from the store as of December 2015). Source code.

Sören contributed a SubToMe Firefox extension!

WordPress plugin. Install it by following these instructions or look for SubToMe in your WordPress Dashboard's plugin interface.

Todo

Check Github Issues for more TODOs

Going Further

We intentionally pushed the complexity down to the subscribing application, which should be smart enough to handle subscriptions if it has registered as such.

The subscribing application is in charge of extracting the data to which the user can subscribe (RSS or Atom feed, Social network handle, ... etc), from the page URL.

Registration for popular readers

Check the store.

Feel free to add yours if you implemented registration. Make sure you support registration as well for your existing users.

Building SubToMe

SubToMe uses Grunt.js for its build process and tests.

Discussions

The Mozilla Hacks

Zemanta Blog

Thanks

Ant0ine for the Chrome extension, Sören for the Firefox extension, Matthias for his help with the WordPress plugin.

More Repositories

1

indexeddb-backbonejs-adapter

An indexedDB adapter for Backbonejs
JavaScript
248
star
2

xmpp-server

A full blown XMPP server based on https://github.com/node-xmpp/node-xmpp with modules
JavaScript
211
star
3

ejabberd-websockets

An ejabberd component to handle XMPP over Websockets
JavaScript
211
star
4

superpipes

Superfeedr powered pipes!
JavaScript
134
star
5

superfeedr-ruby

Ruby Client for Superfeedr.com, based on Babylon
Ruby
64
star
6

news-bot

This is a news bot which uses Superfeedr's API to send and receive RSS notifications.
JavaScript
53
star
7

notifixlight

Defunct RSS to IM bot, powered by Google App Engine. Check Notifix for a better replacement!
Python
48
star
8

feediscovery

Feed discovery to share :)
Python
40
star
9

rack-superfeedr

A gem that provides a rack middleware to interract with Superfeedr's API.
Ruby
38
star
10

superfeedr-node

A library to interract with Superfeedr's XMPP API in any node application
JavaScript
31
star
11

superfeedr-python

Superfeedr API Wrapper in Python
Python
25
star
12

popular-feeds

Various Lists of Popular feeds curated by Superfeedr and team :)
21
star
13

river.news

A river of news application implemented in React which uses Superfeedr for its backend
JavaScript
18
star
14

documentation

The Superfeedr Documentation
HTML
15
star
15

ChitChatRooms

A small Chat Application on Google App Engine with file exchange and XMPP integration
Python
15
star
16

superfeedr-engine

A Superfeedr engine for Ruby on Rails. Handles notifications for you.
Ruby
12
star
17

feender

A module that's able to extract feed urls from any url.
JavaScript
11
star
18

pubsubjubhub

A PubSubHubbub subscriber in Javascript
Python
11
star
19

readernews

A Superfeedr API retrieve demo as a React application
JavaScript
9
star
20

node-relmeauth

A rel=me auth middleware implementation in node.js. Works with any connect-type web application
JavaScript
9
star
21

superfeedr-pshb

PubSubHubbub API wrapper for Superfeedr
JavaScript
8
star
22

superfeedr-jquery

A Jquery plugin to access Superfeedr's retrieve API
JavaScript
7
star
23

node-feediscovery

A wrapper around http://feediscovery.appspot.com/
JavaScript
6
star
24

superfeedr-hapi

A module for Hapi.js Node.js web server
JavaScript
6
star
25

superfeedr-node-sample

This is a sample application to show how you can use node-superfeedr on Heroku!
JavaScript
4
star
26

feedbox

A dropbox for RSS feeds
HTML
4
star
27

angular-superfeedr

An Angular Provider which wraps the Superfeedr HTTP API
4
star
28

feediscovery-rb

A ruby gem for http://feediscovery.appspot.com/
Ruby
3
star
29

supergrover

A Superfeedr to Grove.io brigde hosted on Heroku.
JavaScript
2
star
30

webhooks-test

An app to test Github's webhhoks!
1
star
31

superfeedr-rb

A Superfeedr API library written on top of Blather
Ruby
1
star
32

superfeedr-publisher-callback

Publisher Callback Sample Application
Python
1
star
33

blog.superfeedr.com

http://blog.superfeedr.com
1
star
34

superfeedr-connect-middleware

PuSH & Superfeedr middleware for Node.js (Connect/Express)
JavaScript
1
star