README

Fork Notes

Fork of : https://github.com/aaronpk/picofeed with ....

• 2024/05/28 - add PHP8.2 support (remove PHP deprecation warnings etc), tentatively tag as v1.0.0
• 2024/12/11 - add github action, token fixes to unit tests (some fail still), moved minimum PHP variant to 7.4

Installation :

composer require orlo/picofeed

Note, package is marked to replace :

• p3k/picofeed (which is this is forked from), and
• miniflux/picofeed

Original Readme

PicoFeed was originally developed for Miniflux, a minimalist and open source news reader.

This fork of PicoFeed was created after the original author dropped support. It was published on Packagist as p3k/picofeed.

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: MIT

Requirements

• PHP >= 5.3
• libxml >= 2.7
• XML PHP extensions: DOM and SimpleXML
• cURL or Stream Context (allow_url_fopen=On)
• iconv extension

Authors

• Original author: Frédéric Guillot
• Major Contributors:
  • Bernhard Posselt
  • David Pennington
  • Mathias Kresin

Real world usage

• Miniflux
• Owncloud News
• XRay
• Aperture

Documentation

• Installation
• Running unit tests
• Feed parsing
• Feed creation
• Favicon fetcher
• OPML
• Image proxy (avoid SSL mixed content warnings)
• Web scraping
• Exceptions
• Debugging
• Configuration