Skip to content

OpenHaus/subtome

 
 

Repository files navigation

Subscribe Button

SubToMe is a universal subscribe button. It decouples the content to which a user can susbcribe from the application this user may want to use to perform the subscription. It's losely 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 intented 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 povide 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. 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

  • Internationalize
  • Find ways to support non web based readers
  • Find a hack to allow of a complete redirect with default settings. At this point, it seems extremely complex, as we would need a direct user action to do such. Most browsers tested at this point will opening of new windows as popups at this point :/

Check Github Issues for more TODOs

Going Further

We intentionaly 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.

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.

About

A universal Subscribe/Follow button.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 87.9%
  • PHP 12.1%