summaryrefslogtreecommitdiffstats
path: root/vendor/fguillot/picofeed/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/fguillot/picofeed/README.markdown')
m---------vendor/fguillot/picofeed0
-rw-r--r--vendor/fguillot/picofeed/README.markdown67
2 files changed, 67 insertions, 0 deletions
diff --git a/vendor/fguillot/picofeed b/vendor/fguillot/picofeed
deleted file mode 160000
-Subproject 0a1d0d3950f7f047dc8fb1d80aa6296e15f306d
diff --git a/vendor/fguillot/picofeed/README.markdown b/vendor/fguillot/picofeed/README.markdown
new file mode 100644
index 000000000..ea18adbb6
--- /dev/null
+++ b/vendor/fguillot/picofeed/README.markdown
@@ -0,0 +1,67 @@
+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)
+ - [Mathias Kresin](https://github.com/mkresin)
+
+Real world usage
+----------------
+
+- [AnythingNew](http://anythingnew.co)
+- [Miniflux](http://miniflux.net)
+- [Owncloud News](https://github.com/owncloud/news)
+
+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)
+- [Image proxy](docs/image-proxy.markdown) (avoid SSL mixed content warnings)
+- [Web scraping](docs/grabber.markdown)
+- [Exceptions](docs/exceptions.markdown)
+- [Debugging](docs/debugging.markdown)
+- [Configuration](docs/config.markdown)