feedability

feedability copied to clipboard

h1. Feedability

"Feedability":https://github.com/4poc/feedability/ is a proxy server for atom and rss feeds that tries to make them more usable by including the full content of each article. It uses "arc90labs":http://lab.arc90.com/ original "readability":http://code.google.com/p/arc90labs-readability/, a client bookmarklet written in javascript, for main content extraction/information extraction. Feedability is using the networking framework "node.js":http://nodejs.org/, it furthermore depends on the "readability node.js library":https://github.com/arrix/node-readability by "arrix":https://github.com/arrix, "node bindings":https://github.com/astro/node-expat for the fast "xml parser expat":http://expat.sourceforge.net/ by "Astro":https://github.com/astro, "node bindings":https://github.com/bnoordhuis/node-iconv for the charset recoding library "iconv":http://www.gnu.org/software/libiconv/ by "bnoordhuis":https://github.com/bnoordhuis, "jQuery":http://jquery.com/ developed by "The jQuery Project Team":http://jquery.org/team and "node-sqlite":https://github.com/orlandov/node-sqlite by "grumdrig":https://github.com/grumdrig and "orlandov":https://github.com/orlandov.

h2. Installation

I will try to create a first release candidate soon, until now you need to use the master branch. Make sure you've installed a recent version of node ("wiki":https://github.com/ry/node/wiki/) and npm ("README":https://github.com/isaacs/npm#readme). Tested with node 0.6.4 and npm 1.1.0.

• Clone the repository:

git clone git://github.com/4poc/feedability.git
cd feedability/

• Install the required libraries: (node-sqlite is optional, only necessary if you want to import firefox cookies)

npm install readability jsdom node-expat iconv sqlite
# OR globally:
sudo npm install -g readability jsdom node-expat iconv sqlite

• To start the server: @node feedability.js@ ...
• but I recommend to demonize it, using forever (@sudo npm install -g forever@) or similar: @forever start -l forever.log -o forever_stdout.log -e forever_stderr.log feedability.js@
• For more documentation visit the "wiki":https://github.com/4poc/feedability/wiki
• Please report bugs!

h2. Contact

• Please report any issue or feature request by creating a new issue in this git repository.
• Write me an mail: apoc =at= sixserv +dot+ org (GPG: 0xA155B8CB) (Jabber: [email protected])
• You can find me at "Freenode":http://freenode.net/ or "Teranetworks":http://geekosphere.org/irc/ / "webchat":https://webchat.geekosphere.org/?channels=sixserv (nickname: apoc)

h2. External Copyright and License

• "node.js":http://nodejs.org/ (Copyright (c) 2009, 2010 Ryan Lienhart Dahl. All rights reserved.): released under the MIT license.
• "arc90labs-readability":http://code.google.com/p/arc90labs-readability/ (original written by the arc90 team): released under the Apache License 2.0.
• "node-readability":https://github.com/arrix/node-readability (Copyright (c) 2010 Arrix Zhou): released under the MIT license.
• "node-expat":https://github.com/astro/node-expat (Copyright (c) 2010 Stephan Maka): released under the MIT license.
• "node-iconv":https://github.com/bnoordhuis/node-iconv (Copyright (c) 2010 Ben Noordhuis): released under the MIT license.
• "jquery":http://jquery.com/ (Copyright (c) 2010 The jQuery Project): released under the terms of either the MIT License or the GNU General Public License (GPL) Version 2.

h2. Feedability License and Copyleft

Feedability: NodeJS Feed Proxy With Readability

Copyright (c) 2011, Matthias - apoc - Hecker <"http://apoc.cc/":http://apoc.cc/>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <"http://www.gnu.org/licenses/":http://www.gnu.org/licenses/>.

h2. Similar Projects

Here a few alternative services and projects that try to solve the same problem:

• "Readable Feeds":http://andrewtrusty.appspot.com/readability/
• "Full Text RSS Feed Builder":http://fulltextrssfeed.com/
• "fivefilters.org: Full-Text RSS Feeds":http://fivefilters.org/content-only/