lib/simplepie/README.markdown

   1 # SimplePie
   2
   3 ## Authors and contributors
   4 ### Current
   5 * [Ryan McCue](http://ryanmccue.info) (Maintainer, support)
   6
   7 ### Alumni
   8 * [Ryan Parman](http://ryanparman.com) (Creator, developer, evangelism, support)
   9 * [Geoffrey Sneddon](http://gsnedders.com) (Lead developer)
  10 * [Michael Shipley](http://michaelpshipley.com) (Submitter of patches, support)
  11 * [Steve Minutillo](http://minutillo.com/steve/) (Submitter of patches)
  12
  13 ### Contributors
  14 For a complete list of contributors:
  15
  16 1. Pull down the latest SimplePie code
  17 2. In the `simplepie` directory, run `git shortlog -ns`
  18
  19
  20 ## Requirements
  21 * PHP 5.1.4 or newer
  22 * libxml2 (certain 2.7.x releases are too buggy for words, and will crash)
  23 * Either the iconv or mbstring extension
  24 * cURL or fsockopen()
  25 * PCRE support
  26
  27 If you're looking for PHP 4.x support, pull the "1.2" tag, as that's the last version to support PHP 4.x.
  28
  29
  30 ## License
  31 [New BSD license](http://www.opensource.org/licenses/bsd-license.php)
  32
  33
  34 ## Project status
  35 SimplePie is currently maintained by Ryan McCue.
  36
  37 SimplePie is currently in "low-power mode." If the community decides that SimplePie is a valuable tool, then the community will come together to maintain it into the future.
  38
  39 If you're interested in getting involved with SimplePie, please get in touch with Ryan McCue.
  40
  41
  42 ## Roadmap
  43 SimplePie 1.3 should be a thoughtful reduction of features. Remove some bloat, slim it down, and break it into smaller, more manageable chunks.
  44
  45 Removing PHP 4.x support will certainly help with the slimming. It will also help avoid certain issues that frequently crop up with PHP 4.x. The PHP5-only migration is underway, but there is still quite a bit of work before it's "clean."
  46
  47
  48 ## What comes in the package?
  49 1. `simplepie.inc` - The SimplePie library.  This is all that's required for your pages.
  50 2. `README.markdown` - This document.
  51 3. `LICENSE.txt` - A copy of the BSD license.
  52 4. `compatibility_test/` - The SimplePie compatibility test that checks your server for required settings.
  53 5. `demo/` - A basic feed reader demo that shows off some of SimplePie's more noticable features.
  54 6. `idn/` - A third-party library that SimplePie can optionally use to understand Internationalized Domain Names (IDNs).
  55 7. `test/` - SimplePie's unit test suite.
  56
  57
  58 ## To start the demo
  59 1. Upload this package to your webserver.
  60 2. Make sure that the cache folder inside of the demo folder is server-writable.
  61 3. Navigate your browser to the demo folder.
  62
  63
  64 ## Need support?
  65 For further setup and install documentation, function references, etc., visit:
  66 [http://simplepie.org/wiki/](http://simplepie.org/wiki/)
  67
  68 For bug reports and feature requests, visit:
  69 [http://github.com/rmccue/simplepie/issues](http://github.com/rmccue/simplepie/issues)
  70
  71 Support mailing list -- powered by users, for users.
  72 [http://tech.groups.yahoo.com/group/simplepie-support/](http://tech.groups.yahoo.com/group/simplepie-support/)
  73
  74
  75 ## Recently removed
  76 The following have recently been removed:
  77
  78 * Parameters for SimplePie::__construct()
  79 * add_to_*
  80 * display_cached_file
  81 * enable_xml_dump
  82 * get_favicon
  83 * set_favicon_handler
  84 * subscribe_* (except subscribe_url)
  85 * utf8_bad_replace