|
| 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 5.2.0 or newer |
| 15 | +* libxml2 (certain 2.7.x releases are too buggy for words, and will crash) |
| 16 | +* Either the iconv or mbstring extension |
| 17 | +* cURL or fsockopen() |
| 18 | +* PCRE support |
| 19 | + |
| 20 | +If you're looking for PHP 4.x support, pull the "one-dot-two" branch, as that's |
| 21 | +the last version to support PHP 4.x. |
| 22 | + |
| 23 | + |
| 24 | +What comes in the package? |
| 25 | +-------------------------- |
| 26 | +1. `library/` - SimplePie classes for use with the autoloader |
| 27 | +2. `autoloader.php` - The SimplePie Autoloader if you want to use the separate |
| 28 | + file version. |
| 29 | +3. `README.markdown` - This document. |
| 30 | +4. `LICENSE.txt` - A copy of the BSD license. |
| 31 | +5. `compatibility_test/` - The SimplePie compatibility test that checks your |
| 32 | + server for required settings. |
| 33 | +6. `demo/` - A basic feed reader demo that shows off some of SimplePie's more |
| 34 | + noticeable features. |
| 35 | +7. `idn/` - A third-party library that SimplePie can optionally use to |
| 36 | + understand Internationalized Domain Names (IDNs). |
| 37 | +8. `build/` - Scripts related to generating pieces of SimplePie |
| 38 | +9. `test/` - SimplePie's unit test suite. |
| 39 | + |
| 40 | +### Where's `simplepie.inc`? |
| 41 | +For SimplePie 1.3, we've split the classes into separate files to make it easier |
| 42 | +to maintain and use. |
| 43 | + |
| 44 | +If you'd like a single monolithic file, you can run `php build/compile.php` to |
| 45 | +generate `SimplePie.compiled.php`, or grab a copy from |
| 46 | +[dev.simplepie.org][dev_compiled] (this is kept up-to-date with the latest |
| 47 | +code from Git). |
| 48 | + |
| 49 | +[dev_compiled]: http://dev.simplepie.org/SimplePie.compiled.php |
| 50 | + |
| 51 | + |
| 52 | +To start the demo |
| 53 | +----------------- |
| 54 | +1. Upload this package to your webserver. |
| 55 | +2. Make sure that the cache folder inside of the demo folder is server-writable. |
| 56 | +3. Navigate your browser to the demo folder. |
| 57 | + |
| 58 | + |
| 59 | +Need support? |
| 60 | +------------- |
| 61 | +For further setup and install documentation, function references, etc., visit |
| 62 | +[the wiki][wiki]. If you're using the latest version off GitHub, you can also |
| 63 | +check out the [API documentation][]. |
| 64 | + |
| 65 | +If you can't find an answer to your question in the documentation, head on over |
| 66 | +to one of our [support channels][]. For bug reports and feature requests, visit |
| 67 | +the [issue tracker][]. |
| 68 | + |
| 69 | +[API documentation]: http://dev.simplepie.org/api/ |
| 70 | +[wiki]: http://simplepie.org/wiki/ |
| 71 | +[support channels]: http://simplepie.org/support/ |
| 72 | +[issue tracker]: http://github.com/simplepie/simplepie/issues |
| 73 | + |
| 74 | + |
| 75 | +Project status |
| 76 | +-------------- |
| 77 | +SimplePie is currently maintained by Ryan McCue. |
| 78 | + |
| 79 | +As an open source project, SimplePie is maintained on a somewhat sporadic basis. |
| 80 | +This means that feature requests may not be fulfilled straight away, as time has |
| 81 | +to be prioritized. |
| 82 | + |
| 83 | +If you'd like to contribute to SimplePie, the best way to get started is to fork |
| 84 | +the project on GitHub and send pull requests for patches. When doing so, please |
| 85 | +be aware of our [coding standards][]. |
| 86 | + |
| 87 | +[coding standards]: http://simplepie.org/wiki/misc/coding_standards |
| 88 | + |
| 89 | + |
| 90 | +Authors and contributors |
| 91 | +------------------------ |
| 92 | +### Current |
| 93 | +* [Ryan McCue][] (Maintainer, support) |
| 94 | + |
| 95 | +### Alumni |
| 96 | +* [Ryan Parman][] (Creator, developer, evangelism, support) |
| 97 | +* [Geoffrey Sneddon][] (Lead developer) |
| 98 | +* [Michael Shipley][] (Submitter of patches, support) |
| 99 | +* [Steve Minutillo][] (Submitter of patches) |
| 100 | + |
| 101 | +[Ryan McCue]: http://ryanmccue.info |
| 102 | +[Ryan Parman]: http://ryanparman.com |
| 103 | +[Geoffrey Sneddon]: http://gsnedders.com |
| 104 | +[Michael Shipley]: http://michaelpshipley.com |
| 105 | +[Steve Minutillo]: http://minutillo.com/steve/ |
| 106 | + |
| 107 | + |
| 108 | +### Contributors |
| 109 | +For a complete list of contributors: |
| 110 | + |
| 111 | +1. Pull down the latest SimplePie code |
| 112 | +2. In the `simplepie` directory, run `git shortlog -ns` |
| 113 | + |
| 114 | + |
| 115 | +License |
| 116 | +------- |
| 117 | +[New BSD license](http://www.opensource.org/licenses/BSD-3-Clause) |
0 commit comments