diff options
Diffstat (limited to 'vendor/fguillot/picofeed/README.markdown')
-rw-r--r-- | vendor/fguillot/picofeed/README.markdown | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/vendor/fguillot/picofeed/README.markdown b/vendor/fguillot/picofeed/README.markdown new file mode 100644 index 000000000..8f01b4e8e --- /dev/null +++ b/vendor/fguillot/picofeed/README.markdown @@ -0,0 +1,57 @@ +PicoFeed +======== + +PicoFeed was originally developed for [Miniflux](http://miniflux.net), a minimalist and open source news reader. + +However, this library can be used inside any project. +PicoFeed is tested with a lot of different feeds and it's simple and easy to use. + +[![Build Status](https://travis-ci.org/fguillot/picoFeed.svg?branch=master)](https://travis-ci.org/fguillot/picoFeed) + +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/fguillot/picoFeed/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/fguillot/picoFeed/?branch=master) + +Features +-------- + +- Simple and fast +- Feed parser for Atom 1.0 and RSS 0.91, 0.92, 1.0 and 2.0 +- Feed writer for Atom 1.0 and RSS 2.0 +- Favicon fetcher +- Import/Export OPML subscriptions +- Content filter: HTML cleanup, remove pixel trackers and Ads +- Multiple HTTP client adapters: cURL or Stream Context +- Proxy support +- Content grabber: download from the original website the full content +- Enclosure detection +- RTL languages support +- License: Unlicense <http://unlicense.org/> + +Requirements +------------ + +- PHP >= 5.3 +- libxml >= 2.7 +- XML PHP extensions: DOM and SimpleXML +- cURL or Stream Context (`allow_url_fopen=On`) + +Authors +------- + +- Original author: [Frédéric Guillot](http://fredericguillot.com/) +- Major Contributors: + - [Bernhard Posselt](https://github.com/Raydiation) + - [David Pennington](https://github.com/Xeoncross) + +Documentation +------------- + +- [Installation](docs/installation.markdown) +- [Running unit tests](docs/tests.markdown) +- [Feed parsing](docs/feed-parsing.markdown) +- [Feed creation](docs/feed-creation.markdown) +- [Favicon fetcher](docs/favicon.markdown) +- [OPML file importation](docs/opml-import.markdown) +- [OPML file exportation](docs/opml-export.markdown) +- [Web scraping](docs/grabber.markdown) +- [Debugging](docs/debugging.markdown) +- [Configuration](docs/config.markdown) |