From 414a16008658448850647dc43d5012194ce495f3 Mon Sep 17 00:00:00 2001 From: "FiveFilters.org" Date: Sat, 4 Sep 2021 17:47:57 +0200 Subject: Update current state of the PHP port + authors file --- AUTHORS.md | 1 + README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index cc420e3..fabdb5a 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -11,3 +11,4 @@ The AUTHORS/Contributors are (and/or have been): * Sergiy Lavryk * Pedro Amorim * Malu Decks +* Keyvan Minoukadeh diff --git a/README.md b/README.md index 3eaceab..c910714 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,12 @@ The project aim is to be a 1 to 1 port of Mozilla's version and to follow closel **Developer/Maintainer**: FiveFilters.org +## Code porting + +Master branch - Up to date on 26 August 2021, with the exception of a [piece of code](https://github.com/fivefilters/readability.php/commit/1c662465bded2ab3acf3b975a1315c8c45f0bf73#diff-b9b31807b1a39caec18ddc293e9c52931ba8b55191c61e6b77a623d699a599ffR1899) which doesn't produce the same results in PHP for us compard to the JS version. Perhaps there's an error, or some difference in the underlying code that affects this. If you know what's wrong, please feel free to drop us a note or submit a pull request. :) + +Version 2.1.0 - Up to date with Readability.js up to [19 Nov 2018](https://github.com/mozilla/readability/commit/876c81f710711ba2afb36dd83889d4c5b4fc2743). + ## Requirements PHP 7.3+, ext-dom, ext-xml, and ext-mbstring. To install these dependencies (in the rare case your system does not have them already), you could try something like this in *nix like environments: @@ -193,12 +199,6 @@ the output of Readability. We would also recommend using [CSP](https://developer restrictions to what you allow the resulting content to do. The Firefox integration of reader mode uses both of these techniques itself. Sanitizing unsafe content out of the input is explicitly not something we aim to do as part of Readability itself - there are other good sanitizer libraries out there, use them! -## Code porting - -Version 2.1.0 - Up to date with Readability.js up to [19 Nov 2018](https://github.com/mozilla/readability/commit/876c81f710711ba2afb36dd83889d4c5b4fc2743). - -Master branch - Up to date on 26 August 2021, with the exception of a [piece of code](https://github.com/fivefilters/readability.php/commit/1c662465bded2ab3acf3b975a1315c8c45f0bf73#diff-b9b31807b1a39caec18ddc293e9c52931ba8b55191c61e6b77a623d699a599ffR1899) which doesn't produce the same results for us. - ## Testing Any version of PHP from 7.3 and above installed locally should be enough to develop new features and add new test cases. If you want to be 100% sure that your change doesn't create any issues with other versions of PHP, you can use the provided Docker containers to test currently in 7.3, 7.4, and 8.0. -- cgit v1.2.3