diff options
Diffstat (limited to 'simplepie/README.markdown')
-rw-r--r-- | simplepie/README.markdown | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/simplepie/README.markdown b/simplepie/README.markdown new file mode 100644 index 000000000..e5ca021ce --- /dev/null +++ b/simplepie/README.markdown @@ -0,0 +1,53 @@ +# SimplePie + +## Authors and contributors + +* [Ryan Parman](http://ryanparman.com) +* [Geoffrey Sneddon](http://gsnedders.com) +* [Ryan McCue](http://ryanmccue.info) +* [Michael Shipley](http://michaelpshipley.com) +* [Steve Minutillo](http://minutillo.com/steve/) + + +## License + +[New BSD license](http://www.opensource.org/licenses/bsd-license.php) + + +## Project status + +SimplePie is currently maintained by Ryan McCue. + +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. + +If you're interested in getting involved with SimplePie, please get in touch with Ryan McCue. + + +## What comes in the package? + +1. `simplepie.inc` - The SimplePie library. This is all that's required for your pages. +2. `README.markdown` - This document. +3. `LICENSE.txt` - A copy of the BSD license. +4. `compatibility_test/` - The SimplePie compatibility test that checks your server for required settings. +5. `demo/` - A basic feed reader demo that shows off some of SimplePie's more noticable features. +6. `idn/` - A third-party library that SimplePie can optionally use to understand Internationalized Domain Names (IDNs). +7. `test/` - SimplePie's unit test suite. + + +## To start the demo + +1. Upload this package to your webserver. +2. Make sure that the cache folder inside of the demo folder is server-writable. +3. Navigate your browser to the demo folder. + + +## Need support? + +For further setup and install documentation, function references, etc., visit: +[http://simplepie.org/wiki/](http://simplepie.org/wiki/) + +For bug reports and feature requests, visit: +[http://github.com/rmccue/simplepie/issues](http://github.com/rmccue/simplepie/issues) + +Support mailing list -- powered by users, for users. +[http://tech.groups.yahoo.com/group/simplepie-support/](http://tech.groups.yahoo.com/group/simplepie-support/) |