You are here

Home » API reference » FeedAPI 6

README.txt in FeedAPI 6

Same filename in this branch
  1. 6 README.txt
  2. 6 feedapi_inherit/README.txt
Same filename and directory in other branches
  1. 5 README.txt
Purpose and features
--------------------

FeedAPI aggregates feeds on a Drupal website by generating nodes from feeds. 
It provides a straightforward configuration for most use cases and is 
extensible through an API.

* RSS, Atom and RDF feed support
* CSV, ical, KML parsing is available with 3rd party modules
* Drush integration
* Views integration
* OG integration
* Store data from feeds in CCK fields (Feed Element Mapper)
  Read INSTALL.txt about how to get started using the module.

Developers
----------

Take a look on the API documentation if you want to develop for FeedAPI: 
feedapi.api.php

Performance
-----------

Parser Common Syndication is generally faster than Parser SimplePie because it 
uses PHP5-only SimpleXML library.

For large-scale deployments or with special needs, consider refreshing your feeds 
with Drush. Running cron with drush (drush cron) uses significantly less memory, 
in some cases refreshing single feeds with drush can be benefitial 
(drush feedapi refresh [node nid]).

Known issues
------------

* Parser SimplePie submodule may be incompatible with other modules which include
  SimplePie (for example Activity Stream)
* Do not use FeedAPI and poormanscron together (http://drupal.org/node/235328)
* Grant "use local files as feeds" permission when it's non-avoidable. Use it only when you know exactly what you want to do.

Author/credits
--------------

* The maintainers are Áron Novák (http://drupal.org/user/61864) and Alexander Barth (http://drupal.org/user/53995).
  I got lots of useful responses from my mentors
  Ken Rickard, Károly Négyesi (chx), David Norman (deekayen) and Alex Barth.

Sponsored by Development Seed
Started as a Summer of Code 2007 project.

File

README.txt
View source 
  1. 

  2. Purpose and features

  3. --------------------

  4. 

  5. FeedAPI aggregates feeds on a Drupal website by generating nodes from feeds. 

  6. It provides a straightforward configuration for most use cases and is 

  7. extensible through an API.

  8. 

  9. * RSS, Atom and RDF feed support

  10. * CSV, ical, KML parsing is available with 3rd party modules

  11. * Drush integration

  12. * Views integration

  13. * OG integration

  14. * Store data from feeds in CCK fields (Feed Element Mapper)

  15.   Read INSTALL.txt about how to get started using the module.

  16. 

  17. Developers

  18. ----------

  19. 

  20. Take a look on the API documentation if you want to develop for FeedAPI: 

  21. feedapi.api.php

  22. 

  23. Performance

  24. -----------

  25. 

  26. Parser Common Syndication is generally faster than Parser SimplePie because it 

  27. uses PHP5-only SimpleXML library.

  28. 

  29. For large-scale deployments or with special needs, consider refreshing your feeds 

  30. with Drush. Running cron with drush (drush cron) uses significantly less memory, 

  31. in some cases refreshing single feeds with drush can be benefitial 

  32. (drush feedapi refresh [node nid]).

  33. 

  34. Known issues

  35. ------------

  36. 

  37. * Parser SimplePie submodule may be incompatible with other modules which include

  38.   SimplePie (for example Activity Stream)

  39. * Do not use FeedAPI and poormanscron together (http://drupal.org/node/235328)

  40. * Grant "use local files as feeds" permission when it's non-avoidable. Use it only when you know exactly what you want to do.

  41. 

  42. Author/credits

  43. --------------

  44. 

  45. * The maintainers are Áron Novák (http://drupal.org/user/61864) and Alexander Barth (http://drupal.org/user/53995).

  46.   I got lots of useful responses from my mentors

  47.   Ken Rickard, Károly Négyesi (chx), David Norman (deekayen) and Alex Barth.

  48. 

  49. Sponsored by Development Seed

  50. Started as a Summer of Code 2007 project.