From adf7970f5daf324e51176fdd9600494e598627ea Mon Sep 17 00:00:00 2001 From: Andres Rey Date: Sun, 12 Nov 2017 18:54:57 +0000 Subject: Update readme and changelog --- CHANGELOG.md | 2 ++ README.md | 1 + 2 files changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f43b448..40e5b20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file. ## Unreleased - Merged PR #24. Fixes notice when trying to extract `og:image` +- Up to date to commit [eb221c5](https://github.com/mozilla/readability/commit/c3ff1a2d2c94c1db257b2c9aa88a4b8fbeb221c5) (2017-10-16), which included the following changes: + - test - Added license ## [v0.2.2](https://github.com/andreskrey/readability.php/releases/tag/v0.2.2) diff --git a/README.md b/README.md index af2244a..e0842a5 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ If the parsing process was unsuccessful the HTMLParser will return `false` ## Options - **maxTopCandidates**: default value `5`, max amount of top level candidates. +- **wordThreshold**: default value `500`, minimum amount of characters to consider that the article was parsed successful. - **articleByLine**: default value `false`, search for the article byline and remove it from the text. It will be moved to the article metadata. - **stripUnlikelyCandidates**: default value `true`, remove nodes that are unlikely to have relevant information. Useful for debugging or parsing complex or non-standard articles. - **cleanConditionally**: default value `true`, remove certain nodes after parsing to return a cleaner result. -- cgit v1.2.3