1SimplePie
2=========
3
4SimplePie is a very fast and easy-to-use class, written in PHP, that puts the
5'simple' back into 'really simple syndication'.  Flexible enough to suit
6beginners and veterans alike, SimplePie is focused on [speed, ease of use,
7compatibility and standards compliance][what_is].
8
9[what_is]: http://simplepie.org/wiki/faq/what_is_simplepie
10
11
12Requirements
13------------
14* PHP 5.6+ (Required since SimplePie 1.5.3)
15* libxml2 (certain 2.7.x releases are too buggy for words, and will crash)
16* One of iconv, mbstring or intl extensions
17* cURL or fsockopen()
18* PCRE support
19
20
21What comes in the package?
22--------------------------
231. `library/` - SimplePie classes for use with the autoloader
242. `autoloader.php` - The SimplePie Autoloader if you want to use the separate
25   file version.
263. `README.markdown` - This document.
274. `LICENSE.txt` - A copy of the BSD license.
285. `compatibility_test/` - The SimplePie compatibility test that checks your
29   server for required settings.
306. `demo/` - A basic feed reader demo that shows off some of SimplePie's more
31   noticeable features.
327. `idn/` - A third-party library that SimplePie can optionally use to
33   understand Internationalized Domain Names (IDNs).
348. `build/` - Scripts related to generating pieces of SimplePie
359. `test/` - SimplePie's unit test suite.
36
37### Where's `simplepie.inc`?
38Since SimplePie 1.3, we've split the classes into separate files to make it easier
39to maintain and use.
40
41If you'd like a single monolithic file, you can run `php build/compile.php` to
42generate `SimplePie.compiled.php`.
43
44To start the demo
45-----------------
461. Upload this package to your webserver.
472. Make sure that the cache folder inside of the demo folder is server-writable.
483. Navigate your browser to the demo folder.
49
50
51Need support?
52-------------
53For further setup and install documentation, function references, etc., visit
54[the wiki][wiki]. If you're using the latest version off GitHub, you can also
55check out the [API documentation][].
56
57If you can't find an answer to your question in the documentation, head on over
58to one of our [support channels][]. For bug reports and feature requests, visit
59the [issue tracker][].
60
61[API documentation]: http://dev.simplepie.org/api/
62[wiki]: http://simplepie.org/wiki/
63[support channels]: http://simplepie.org/support/
64[issue tracker]: http://github.com/simplepie/simplepie/issues
65
66
67Project status
68--------------
69SimplePie is currently maintained by Malcolm Blaney.
70
71As an open source project, SimplePie is maintained on a somewhat sporadic basis.
72This means that feature requests may not be fulfilled straight away, as time has
73to be prioritized.
74
75If you'd like to contribute to SimplePie, the best way to get started is to fork
76the project on GitHub and send pull requests for patches. When doing so, please
77be aware of our [coding standards][].
78
79[coding standards]: http://simplepie.org/wiki/misc/coding_standards
80
81
82Authors and contributors
83------------------------
84### Current
85* [Malcolm Blaney][] (Maintainer, support)
86
87### Alumni
88* [Ryan McCue][] (developer, support)
89* [Ryan Parman][] (Creator, developer, evangelism, support)
90* [Sam Sneddon][] (Lead developer)
91* [Michael Shipley][] (Submitter of patches, support)
92* [Steve Minutillo][] (Submitter of patches)
93
94[Malcolm Blaney]: https://mblaney.xyz
95[Ryan McCue]: http://ryanmccue.info
96[Ryan Parman]: http://ryanparman.com
97[Sam Sneddon]: https://gsnedders.com
98[Michael Shipley]: http://michaelpshipley.com
99[Steve Minutillo]: http://minutillo.com/steve/
100
101
102### Contributors
103For a complete list of contributors:
104
1051. Pull down the latest SimplePie code
1062. In the `simplepie` directory, run `git shortlog -ns`
107
108
109License
110-------
111[New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)
112