summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndres Rey <[email protected]>2017-05-31 10:27:53 +0100
committerAndres Rey <[email protected]>2017-05-31 10:27:53 +0100
commitd30ff4fb1559b5380b34f63f530ece65f0bdcd18 (patch)
tree1f42ea8fd2c55bdef90e019fdcb90229b43308d3
parenta8174636e0398885d6c6052aed38118f241b0c39 (diff)
parent6f5fd8d4a2d9f098c8d1658ec49f912ae12e440f (diff)
Merge branch 'development' into pr-20-new-backup-approach
# Conflicts: # CHANGELOG.md
-rw-r--r--CHANGELOG.md1
-rw-r--r--README.md4
2 files changed, 3 insertions, 2 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ffdb8bd..4548a26 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
## Unreleased
- Added `normalizeEntities` flag to convert UTF-8 characters to its HTML Entity equivalent. Fixes bugs on htmls with mixed encoding.
+- Added more information to the readme.md file
- New way to create a backup DOM: not creating a backup. In the previous version, the system cloned the $this->dom object to keep it as a backup in order to restart the algorithm with other flags, if needed. This seemed to work until I realized that *sometimes* the backup changes even if we are not touching it. Seems that the `dom` and `backupdom` objects are linked and *some* changes on the dom object reach the bakcupdom object. The new approach consists in deleting the backupdom object and recreating from scratch the dom object. Of course this has a performance impact, but seems to be quite low.
## [v0.2.0](https://github.com/andreskrey/readability.php/releases/tag/v0.2.0)
diff --git a/README.md b/README.md
index ee3bfd9..5c98178 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Readability.php
[![Latest Stable Version](https://poser.pugx.org/andreskrey/readability.php/v/stable)](https://packagist.org/packages/andreskrey/readability.php) [![StyleCI](https://styleci.io/repos/71042668/shield?branch=master)](https://styleci.io/repos/71042668) [![Build Status](https://travis-ci.org/andreskrey/readability.php.svg?branch=master)](https://travis-ci.org/andreskrey/readability.php)
-PHP port of *Mozilla's* **[Readability.js](https://github.com/mozilla/readability)**. Parses html text (usually news and other articles) and tries to return title, byline and text content. Analizes each text node, gives an score and orders them based on this calculation.
+PHP port of *Mozilla's* **[Readability.js](https://github.com/mozilla/readability)**. Parses html text (usually news and other articles) and tries to return title, byline and text content without nav bars, ads, footers, or anything that isn't the main body of the text. Analizes each text node, gives an score and orders them based on this calculation.
**Requires**: PHP 5.4+ & DOMDocument (libxml)
@@ -9,7 +9,7 @@ PHP port of *Mozilla's* **[Readability.js](https://github.com/mozilla/readabilit
## Status
-Current status is *ultra-mega-alpha*. It is broken right now and it will change dramatically until the first 1.0 release. Expect wild changes. Submit pull requests. Argue with me.
+Current status is stable. Not _suuuuper_ stable but stable enough.
## How to use it