Rss-Bridge/README.md
Sébastien SAUVAGE 6b9074da2a Update README.md
2014-02-01 14:15:49 +01:00

95 lines
4.5 KiB
Markdown

rss-bridge
===
rss-bridge is a php script capable of generating ATOM feed for specific pages which don't have one.
Supported sites/pages
===
* `FlickrExplore` : [Latest interesting images](http://www.flickr.com/explore) from Flickr.
* `GoogleSearch` : Most recent results from Google Search.
* `Twitter` : Can return keyword/hashtag search or user timeline.
* `Identi.ca` : Identica user timeline (Should be compatible with other Pump.io instances).
* `YouTube` : YouTube user channel feed.
* `Cryptome` : Returns the most recent documents from Cryptome.org.
* `Futurasciences` : Returns the most recent articles from futura-sciences.com.
* `GuruMed`: Returns the most recent articles for gurumed.org
* `DansTonChat`: Most recent quotes from danstonchat.com
* `DuckDuckGo`: Most recent results from DuckDuckGo.com
* `FSBridge`: Most recent article (full text) from futura-sciences.com
* `GuruMed`: Most recent entries (full text) from gurumed.org
* `Instagram`: Most recent photos from an instagram.com user.
* `OpenClassrooms`: Lastest tutorials from fr.openclassrooms.com.
* `Pinterest`: Most recent photos from user or search.
* `ScmbBridge`: Newest stories from secouchermoinsbete.fr
* `WikipediaENLatest`: highlighted articles from Wikipedia in English.
* `WikipediaFRLatest`: highlighted articles from Wikipedia in French.
* `WikipediaEOLatest`: highlighted articles from Wikipedia in Esperanto.
Output format
===
Output format can take several forms:
* `Atom` : ATOM Feed, for use in RSS/Feed readers
* `Json` : Json, for consumption by other applications.
* `Html` : Simple html page.
* `Plaintext` : raw text (php object, as returned by print_r)
Screenshot
===
Welcome screen:
![Screenshot](http://sebsauvage.net/galerie/photos/Bordel/rss-bridge-screenshot-3.png)
Minecraft hashtag (#Minecraft) search on Twitter, in ATOM format (as displayed by Firefox):
![Screenshot](http://sebsauvage.net/galerie/photos/Bordel/rss-bridge-screenshot-2-twitter-hashtag.png)
Requirements
===
* php 5.3
* [PHP Simple HTML DOM Parser](http://simplehtmldom.sourceforge.net). (Put `simple_html_dom.php` in `vendor/simplehtmldom/`).
* Ssl lib activated in PHP config
Author
===
I'm sebsauvage, webmaster of [sebsauvage.net](http://sebsauvage.net), author of [Shaarli](http://sebsauvage.net/wiki/doku.php?id=php:shaarli) and [ZeroBin](http://sebsauvage.net/wiki/doku.php?id=php:zerobin).
Patch/contributors :
* Yves ASTIER ([Draeli](https://github.com/Draeli)) : PHP optimizations, fixes, dynamic brigde/format list with all stuff behind and extend cache system. Mail : contact@yves-astier.com
* [Mitsukarenai](https://github.com/Mitsukarenai) : Initial inspiration, TwitterBridge, IdenticaBridge, YoutubeBridge.
* [ArthurHoaro](https://github.com/ArthurHoaro)
* [BoboTiG](https://github.com/BoboTiG)
* [Astalaseven](https://github.com/Astalaseven)
* [qwertygc](https://github.com/qwertygc)
* [Djuuu](https://github.com/Djuuu)
Licence
===
Code is public domain.
Technical notes
===
* There is a cache so that source services won't ban you even if you hammer the rss-bridge with requests. Each bridge has a different duration for the cache. The `cache` subdirectory will be automatically created. You can purge it whenever you want.
* To implement a new rss-bridge, create a new class in `bridges` subdirectory. Look at existing bridges for examples. For items you generate in `$this->items`, only `uri` and `title` are mandatory in each item. `timestamp` and `content` are optional but recommended. Any additional key will be ignored by ATOM feed (but outputed to jSon).
Rant
===
*Dear so-called "social" websites.*
Your catchword is "share", but you don't want us to share. You want to keep us within your walled gardens. That's why you've been removing RSS links from webpages, hiding them deep on your website, or removed RSS entirely, replacing it with crippled or demented proprietary API. **FUCK YOU.**
You're not social when you hamper sharing by removing RSS. You're happy to have customers create content for your ecosystem, but you don't want this content out - a content you do not even own. Google Takeout is just a gimmick. We want our data to flow, we want RSS.
We want to share with friends, using open protocols: RSS, XMPP, whatever. Because no one wants to have *your* service with *your* applications using *your* API forced-feeded to them. Friends must be free to choose whatever software and service they want.
We are rebuilding bridges your have wilfully destroyed.
Get your shit together: Put RSS back in.