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
21PSR-16: Caching support
22--------------
23
24Since SimplePie 1.8.0 you can use the [PSR-16](https://www.php-fig.org/psr/psr-16/) cache from
25[Symfony](https://symfony.com/doc/current/components/cache.html)
26or [every other implementation](https://packagist.org/providers/psr/simple-cache-implementation).
27
28```php
29$simplepie = new \SimplePie\SimplePie();
30$simplepie->set_cache(
31    new \Symfony\Component\Cache\Psr16Cache(
32        new \Symfony\Component\Cache\Adapter\FilesystemAdapter()
33    ),
34);
35```
36
37What comes in the package?
38--------------------------
391. `src/` - SimplePie classes for use with the autoloader
402. `autoloader.php` - The SimplePie Autoloader if you want to use the separate
41   file version.
423. `README.markdown` - This document.
434. `LICENSE.txt` - A copy of the BSD license.
445. `compatibility_test/` - The SimplePie compatibility test that checks your
45   server for required settings.
466. `demo/` - A basic feed reader demo that shows off some of SimplePie's more
47   noticeable features.
487. `idn/` - A third-party library that SimplePie can optionally use to
49   understand Internationalized Domain Names (IDNs).
508. `build/` - Scripts related to generating pieces of SimplePie
519. `test/` - SimplePie's unit test suite.
52
53### Where's `simplepie.inc`?
54Since SimplePie 1.3, we've split the classes into separate files to make it easier
55to maintain and use.
56
57If you'd like a single monolithic file, see the assets in the
58[releases](https://github.com/simplepie/simplepie/releases), or you can
59run `php build/compile.php` to generate `SimplePie.compiled.php` yourself.
60
61To start the demo
62-----------------
631. Upload this package to your webserver.
642. Make sure that the cache folder inside of the demo folder is server-writable.
653. Navigate your browser to the demo folder.
66
67
68Need support?
69-------------
70For further setup and install documentation, function references, etc., visit
71[the wiki][wiki]. If you're using the latest version off GitHub, you can also
72check out the [API documentation][].
73
74If you can't find an answer to your question in the documentation, head on over
75to one of our [support channels][]. For bug reports and feature requests, visit
76the [issue tracker][].
77
78[API documentation]: http://dev.simplepie.org/api/
79[wiki]: http://simplepie.org/wiki/
80[support channels]: http://simplepie.org/support/
81[issue tracker]: http://github.com/simplepie/simplepie/issues
82
83
84Project status
85--------------
86SimplePie is currently maintained by Malcolm Blaney.
87
88As an open source project, SimplePie is maintained on a somewhat sporadic basis.
89This means that feature requests may not be fulfilled straight away, as time has
90to be prioritized.
91
92If you'd like to contribute to SimplePie, the best way to get started is to fork
93the project on GitHub and send pull requests for patches. When doing so, please
94be aware of our [coding standards](http://simplepie.org/wiki/misc/coding_standards).
95
96The main development for the next minor release happens in `master` branch.
97Please create your pull requests primarily against this branch.
98
99We do not actively provide bug fixes or security fixes for older versions. Nevertheless,
100you are welcome to create backport PRs if you still need support for older PHP versions.
101Please open your PR against the appropriate branch.
102
103| branch                                                                     | requires    |
104|----------------------------------------------------------------------------|-------------|
105| [master](https://github.com/simplepie/simplepie/tree/master)               | PHP 7.2.0+  |
106| [one-dot-seven](https://github.com/simplepie/simplepie/tree/one-dot-seven) | PHP 5.6.0+  |
107| [one-dot-three](https://github.com/simplepie/simplepie/tree/one-dot-three) | PHP 5.2.0+  |
108
109
110Authors and contributors
111------------------------
112### Current
113* [Malcolm Blaney][] (Maintainer, support)
114
115### Alumni
116* [Ryan McCue][] (developer, support)
117* [Ryan Parman][] (Creator, developer, evangelism, support)
118* [Sam Sneddon][] (Lead developer)
119* [Michael Shipley][] (Submitter of patches, support)
120* [Steve Minutillo][] (Submitter of patches)
121
122[Malcolm Blaney]: https://mblaney.xyz
123[Ryan McCue]: http://ryanmccue.info
124[Ryan Parman]: http://ryanparman.com
125[Sam Sneddon]: https://gsnedders.com
126[Michael Shipley]: http://michaelpshipley.com
127[Steve Minutillo]: http://minutillo.com/steve/
128
129
130### Contributors
131For a complete list of contributors:
132
1331. Pull down the latest SimplePie code
1342. In the `simplepie` directory, run `git shortlog -ns`
135
136
137License
138-------
139[New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)
140