Removing translation directories
[project/feedapi.git] / INSTALL.txt
1
2 FeedAPI INSTALLATION INSTRUCTIONS
3 ---------------------------------
4
5 Quick Start Guide
6 -----------------
7
8 Enable FeedAPI, FeedAPI Node and Common Syndication Parser modules. The module
9 automatically creates a content-type called feed.
10
11 To add your first feed, visit node/add/feed and fill the Feed URL field and 
12 click "Save".
13
14 To retrieve feed items manually, click on the Refresh menu tab of the feed node.
15
16 To retrieve feed items regularly from your feeds, configure cron: 
17 http://drupal.org/cron
18
19 Submodules in the package
20 -----------------------------
21
22 1) FeedAPI - Base module.
23 2) FeedAPI Node Processor - Use to create nodes from feed items.
24 4) FeedAPI Inherit - Passes OG or Taxonomy configuration from feed nodes
25    to feed item nodes.
26 5) Common Syndication Parser - Fast SimpleXML based parser.
27 6) SimplePie Parser - Very robust, PHP4-compatible parser.
28    Requires you to download SimplePie from http://www.simplepie.org and move 
29    simplepie.inc file to feedapi/parser_simplepie directory.
30
31 To properly configure a feed content type, you must at least enable 1 parser 
32 (for example Common Syndication) and 1 processor (for example FeedAPI Node).