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 7.2+ (Required since SimplePie 1.8.0)
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. `src/` - 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, see the assets in the
42[releases](https://github.com/simplepie/simplepie/releases), or you can
43run `php build/compile.php` to generate `SimplePie.compiled.php` yourself.
44
45To start the demo
46-----------------
471. Upload this package to your webserver.
482. Make sure that the cache folder inside of the demo folder is server-writable.
493. Navigate your browser to the demo folder.
50
51
52Need support?
53-------------
54For further setup and install documentation, function references, etc., visit
55[the wiki][wiki]. If you're using the latest version off GitHub, you can also
56check out the [API documentation][].
57
58If you can't find an answer to your question in the documentation, head on over
59to one of our [support channels][]. For bug reports and feature requests, visit
60the [issue tracker][].
61
62[API documentation]: http://dev.simplepie.org/api/
63[wiki]: http://simplepie.org/wiki/
64[support channels]: http://simplepie.org/support/
65[issue tracker]: http://github.com/simplepie/simplepie/issues
66
67
68Project status
69--------------
70SimplePie is currently maintained by Malcolm Blaney.
71
72As an open source project, SimplePie is maintained on a somewhat sporadic basis.
73This means that feature requests may not be fulfilled straight away, as time has
74to be prioritized.
75
76If you'd like to contribute to SimplePie, the best way to get started is to fork
77the project on GitHub and send pull requests for patches. When doing so, please
78be aware of our [coding standards](http://simplepie.org/wiki/misc/coding_standards).
79
80The main development for the next minor release happens in `master` branch.
81Please create your pull requests primarily against this branch.
82
83We do not actively provide bug fixes or security fixes for older versions. Nevertheless,
84you are welcome to create backport PRs if you still need support for older PHP versions.
85Please open your PR against the appropriate branch.
86
87| branch                                                                     | requires    |
88|----------------------------------------------------------------------------|-------------|
89| [master](https://github.com/simplepie/simplepie/tree/master)               | PHP 7.2.0+  |
90| [one-dot-seven](https://github.com/simplepie/simplepie/tree/one-dot-seven) | PHP 5.6.0+  |
91| [one-dot-three](https://github.com/simplepie/simplepie/tree/one-dot-three) | PHP 5.2.0+  |
92
93
94Authors and contributors
95------------------------
96### Current
97* [Malcolm Blaney][] (Maintainer, support)
98
99### Alumni
100* [Ryan McCue][] (developer, support)
101* [Ryan Parman][] (Creator, developer, evangelism, support)
102* [Sam Sneddon][] (Lead developer)
103* [Michael Shipley][] (Submitter of patches, support)
104* [Steve Minutillo][] (Submitter of patches)
105
106[Malcolm Blaney]: https://mblaney.xyz
107[Ryan McCue]: http://ryanmccue.info
108[Ryan Parman]: http://ryanparman.com
109[Sam Sneddon]: https://gsnedders.com
110[Michael Shipley]: http://michaelpshipley.com
111[Steve Minutillo]: http://minutillo.com/steve/
112
113
114### Contributors
115For a complete list of contributors:
116
1171. Pull down the latest SimplePie code
1182. In the `simplepie` directory, run `git shortlog -ns`
119
120
121License
122-------
123[New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)
124