lib/simplepie/README.markdown

   1 SimplePie
   2 =========
   3
   4 SimplePie 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
   6 beginners and veterans alike, SimplePie is focused on [speed, ease of use,
   7 compatibility and standards compliance][what_is].
   8
   9 [what_is]: http://simplepie.org/wiki/faq/what_is_simplepie
  10
  11
  12 Requirements
  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
  21 What comes in the package?
  22 --------------------------
  23 1. `src/` - SimplePie classes for use with the autoloader
  24 2. `autoloader.php` - The SimplePie Autoloader if you want to use the separate
  25    file version.
  26 3. `README.markdown` - This document.
  27 4. `LICENSE.txt` - A copy of the BSD license.
  28 5. `compatibility_test/` - The SimplePie compatibility test that checks your
  29    server for required settings.
  30 6. `demo/` - A basic feed reader demo that shows off some of SimplePie's more
  31    noticeable features.
  32 7. `idn/` - A third-party library that SimplePie can optionally use to
  33    understand Internationalized Domain Names (IDNs).
  34 8. `build/` - Scripts related to generating pieces of SimplePie
  35 9. `test/` - SimplePie's unit test suite.
  36
  37 ### Where's `simplepie.inc`?
  38 Since SimplePie 1.3, we've split the classes into separate files to make it easier
  39 to maintain and use.
  40
  41 If you'd like a single monolithic file, see the assets in the
  42 [releases](https://github.com/simplepie/simplepie/releases), or you can
  43 run `php build/compile.php` to generate `SimplePie.compiled.php` yourself.
  44
  45 To start the demo
  46 -----------------
  47 1. Upload this package to your webserver.
  48 2. Make sure that the cache folder inside of the demo folder is server-writable.
  49 3. Navigate your browser to the demo folder.
  50
  51
  52 Need support?
  53 -------------
  54 For 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
  56 check out the [API documentation][].
  57
  58 If you can't find an answer to your question in the documentation, head on over
  59 to one of our [support channels][]. For bug reports and feature requests, visit
  60 the [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
  68 Project status
  69 --------------
  70 SimplePie is currently maintained by Malcolm Blaney.
  71
  72 As an open source project, SimplePie is maintained on a somewhat sporadic basis.
  73 This means that feature requests may not be fulfilled straight away, as time has
  74 to be prioritized.
  75
  76 If you'd like to contribute to SimplePie, the best way to get started is to fork
  77 the project on GitHub and send pull requests for patches. When doing so, please
  78 be aware of our [coding standards](http://simplepie.org/wiki/misc/coding_standards).
  79
  80 The main development for the next minor release happens in `master` branch.
  81 Please create your pull requests primarily against this branch.
  82
  83 We do not actively provide bug fixes or security fixes for older versions. Nevertheless,
  84 you are welcome to create backport PRs if you still need support for older PHP versions.
  85 Please 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
  94 Authors 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
 115 For a complete list of contributors:
 116
 117 1. Pull down the latest SimplePie code
 118 2. In the `simplepie` directory, run `git shortlog -ns`
 119
 120
 121 License
 122 -------
 123 [New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)