Merge branch 'master' of ssh://apples.lambdacomplex.org/git/disclosr
[disclosr.git] / lib / FeedWriter / README
Alex Sadleir 1 This package can be used to generate feeds in either RSS 1.0, RSS 2.0 or ATOM
2 formats.
3
Alex Sadleir 4 There are three main classes that abstract the feed information and another to
Alex Sadleir 5 encapsulate the feed items information.
6
7 Applications can create feed writer object, several feed item objects, set
8 several types of properties of either feeds and feed items, and add items to
9 the feed.
10
11 Once a feed is fully composed with its items, the feed writer class can generate
12 the necessary XML structure to describe the feed in the RSS or ATOM formats.
13 The feed is generated as part of the current feed output.
14
15
16 Requirements
17 ============
18
Alex Sadleir 19 PHP >= 5.3
20
21 If you don't have 5.3 available on your system, there's a version supporting
22 PHP >= 5.0 in the "legacy-php-5.0" branch.
23
24
25 Documentation
26 =============
27
28 The documentation can be found in the "gh-pages" branch or on GitHub Pages:
29 http://mibe.github.io/FeedWriter/
30
31
32 Authors
33 =======
34 (in chronological order)
35
36 Anis uddin Ahmad
37 Michael Bemmerl
38 Phil Freo
39 Paul Ferrett
40 Brennen Bearnes
41 Michael Robinson
42