library/simplepie/README.markdown

   1 # SimplePie
   2
   3 ## Authors and contributors
   4
   5 * [Ryan Parman](http://ryanparman.com)
   6 * [Geoffrey Sneddon](http://gsnedders.com)
   7 * [Ryan McCue](http://ryanmccue.info)
   8 * [Michael Shipley](http://michaelpshipley.com)
   9 * [Steve Minutillo](http://minutillo.com/steve/)
  10
  11
  12 ## License
  13
  14 [New BSD license](http://www.opensource.org/licenses/bsd-license.php)
  15
  16
  17 ## Project status
  18
  19 SimplePie is currently maintained by Ryan McCue.
  20
  21 At the moment, there isn't a lot of active development happening. If the community decides that SimplePie is a valuable tool, then the community will come together to maintain it into the future.
  22
  23 If you're interested in getting involved with SimplePie, please get in touch with Ryan McCue.
  24
  25
  26 ## What comes in the package?
  27
  28 1. `simplepie.inc` - The SimplePie library.  This is all that's required for your pages.
  29 2. `README.markdown` - This document.
  30 3. `LICENSE.txt` - A copy of the BSD license.
  31 4. `compatibility_test/` - The SimplePie compatibility test that checks your server for required settings.
  32 5. `demo/` - A basic feed reader demo that shows off some of SimplePie's more noticable features.
  33 6. `idn/` - A third-party library that SimplePie can optionally use to understand Internationalized Domain Names (IDNs).
  34 7. `test/` - SimplePie's unit test suite.
  35
  36
  37 ## To start the demo
  38
  39 1. Upload this package to your webserver.
  40 2. Make sure that the cache folder inside of the demo folder is server-writable.
  41 3. Navigate your browser to the demo folder.
  42
  43
  44 ## Need support?
  45
  46 For further setup and install documentation, function references, etc., visit:
  47 [http://simplepie.org/wiki/](http://simplepie.org/wiki/)
  48
  49 For bug reports and feature requests, visit:
  50 [http://github.com/rmccue/simplepie/issues](http://github.com/rmccue/simplepie/issues)
  51
  52 Support mailing list -- powered by users, for users.
  53 [http://tech.groups.yahoo.com/group/simplepie-support/](http://tech.groups.yahoo.com/group/simplepie-support/)