This project has been deprecated. Please see Webfeed-follow instead.
This repository contains a library that renders Follow buttons on websites, allowing visitors to follow HTML feeds. The library displays a modal with a best-we-can-do UX, which asks the user if they have a compliant HTML feed reader app installed, and gives them to the download page of a compliant app if they don't.
You can see the official HTML Feeds specification at: https://www.scrollapp.org/specs/htmlfeeds/
Paste this script tag at the bottom of your HTML page:
<script src="https://cdn.jsdelivr.net/npm/follow-lib/follow.min.js"></script>In order to create a button, create a hyperlink with the data-follow attribute populated the feed URLs as shown below:
<a href="#" data-follow="http://a.com/path-to-feed/">Follow me!</a>You can follow multiple feeds at once by specifying a space-separated list of feed URLs:
<a href="#" data-follow="http://a.com/path-to-feed/ http://b.com/path-to-feed/">Follow them!</a>In order for an end user to be able to follow an HTML feed, they must have a compatible reader app installed on their device. You can configure what reader you recommend to your users by including a <meta> tag in the <head> section of your HTML, as shown below.
The meta tag is a space-separated list of key=value pairs, where the key is a well-known string that specifies the platform, and the URL is a download URL where the reader app can be found.
If no such tag exists, this library defaults to using the download URLs for Scroll.
<meta name="recommended-readers" content="
ios=https://itunes.apple.com/app/id1234
android=http://play.google.com/store/apps/details?id=com.app.name
macos=http://myapp.com/app.dmg
windows=http://myapp.com/app.msi
linux=http://myapp.com/app.tar.gz
">// Pass one or more arguments to the Follow.open function
// in order to display the dialog:
Follow.open(
"http://a.com/path-to-feed/",
"http://b.com/path-to-feed/",
...
);
// Configure recommended readers:
Follow.setRecommendedReaders({
ios: "https://itunes.apple.com/app/id1234",
android: "http://play.google.com/store/apps/details?id=com.app.name",
macos: "http://myapp.com/app.dmg",
windows: "http://myapp.com/app.msi",
linux: "http://myapp.com/app.tar.gz",
});