PageRenderTime 1ms CodeModel.GetById 2ms app.highlight 18ms RepoModel.GetById 2ms app.codeStats 0ms

/README.md

https://github.com/nanawel/rss-bridge
Markdown | 103 lines | 73 code | 30 blank | 0 comment | 0 complexity | a991cf1980013be09fb8c334e3422bc4 MD5 | raw file
  1rss-bridge
  2===
  3
  4rss-bridge is a PHP project capable of generating ATOM feeds for websites which don't have one.
  5
  6Supported sites/pages (main)
  7===
  8
  9 * `FlickrExplore` : [Latest interesting images](http://www.flickr.com/explore) from Flickr
 10 * `GoogleSearch` : Most recent results from Google Search
 11 * `Twitter` : Return keyword/hashtag search or user timeline
 12 * `Identi.ca` : Identica user timeline (Should be compatible with other Pump.io instances)
 13 * `YouTube` : YouTube user channel, playlist or search
 14 * `Cryptome` : Returns the most recent documents from [Cryptome.org](http://cryptome.org/)
 15 * `DansTonChat`: Most recent quotes from [danstonchat.com](http://danstonchat.com/)
 16 * `DuckDuckGo`: Most recent results from [DuckDuckGo.com](https://duckduckgo.com/)
 17 * `Instagram`: Most recent photos from an Instagram user
 18 * `OpenClassrooms`: Lastest tutorials from [fr.openclassrooms.com](http://fr.openclassrooms.com/)
 19 * `Pinterest`: Most recent photos from user or search
 20 * `ScmbBridge`: Newest stories from [secouchermoinsbete.fr](http://secouchermoinsbete.fr/)
 21 * `WikipediaENLatest`: highlighted articles from Wikipedia in English
 22 * `WikipediaFRLatest`: highlighted articles from Wikipedia in French
 23 * `WikipediaEOLatest`: highlighted articles from Wikipedia in Esperanto
 24 * `Bandcamp` : Returns last release from [bandcamp](https://bandcamp.com/) for a tag
 25
 26Plus [many other bridges](bridges/) to enable, thanks to the community
 27
 28Output format
 29===
 30Output format can take several forms:
 31
 32 * `Atom` : ATOM Feed, for use in RSS/Feed readers
 33 * `Json` : Json, for consumption by other applications.
 34 * `Html` : Simple html page.
 35 * `Plaintext` : raw text (php object, as returned by print_r)
 36   
 37Screenshot
 38===
 39
 40Welcome screen:
 41
 42![Screenshot](http://sebsauvage.net/galerie/photos/Bordel/rss-bridge-screenshot-3.png)
 43   
 44Minecraft hashtag (#Minecraft) search on Twitter, in ATOM format (as displayed by Firefox):
 45
 46![Screenshot](http://sebsauvage.net/galerie/photos/Bordel/rss-bridge-screenshot-2-twitter-hashtag.png)
 47   
 48Requirements
 49===
 50
 51 * PHP 5.3
 52 * `openssl` extension enabled in PHP config (`php.ini`)
 53
 54Enabling/Disabling bridges
 55===
 56
 57By default, the script creates `whitelist.txt` and adds the main bridges (see above). `whitelist.txt` is ignored by git, you can edit it:
 58 * to enable extra bridges (one bridge per line)
 59 * to disable main bridges (remove the line)
 60
 61New bridges are disabled by default, so make sure to check regularly what's new and whitelist what you want !
 62 
 63Author
 64===
 65I'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).
 66
 67Patch/contributors :
 68
 69 * 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
 70 * [Mitsukarenai](https://github.com/Mitsukarenai) : Initial inspiration, collaborator
 71 * [ArthurHoaro](https://github.com/ArthurHoaro)
 72 * [BoboTiG](https://github.com/BoboTiG)
 73 * [Astalaseven](https://github.com/Astalaseven)
 74 * [qwertygc](https://github.com/qwertygc)
 75 * [Djuuu](https://github.com/Djuuu)
 76 * [Anadrark](https://github.com/Anadrark])
 77
 78License
 79===
 80Code is [Public Domain](UNLICENSE).
 81
 82Including `PHP Simple HTML DOM Parser` under the [MIT License](http://opensource.org/licenses/MIT)
 83
 84
 85Technical notes
 86===
 87  * 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.
 88  * 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).
 89
 90Rant
 91===
 92
 93*Dear so-called "social" websites.*
 94
 95Your 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.**
 96
 97You're not social when you hamper sharing by removing RSS. You're happy to have customers creating 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.
 98
 99We 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 force-feeding them. Friends must be free to choose whatever software and service they want.
100
101We are rebuilding bridges you have wilfully destroyed.
102
103Get your shit together: Put RSS back in.