diff options
| author | Andres Rey <[email protected]> | 2017-05-31 10:11:14 +0100 |
|---|---|---|
| committer | Andres Rey <[email protected]> | 2017-05-31 10:11:14 +0100 |
| commit | 6f5fd8d4a2d9f098c8d1658ec49f912ae12e440f (patch) | |
| tree | 0ddc36d7b818bf161e31149d09fca6cb8e2401a4 | |
| parent | 3cfc8c91b05fac3b3164505bf173508c180b77f8 (diff) | |
Updated readme.md file
| -rw-r--r-- | CHANGELOG.md | 1 | ||||
| -rw-r--r-- | README.md | 4 |
2 files changed, 3 insertions, 2 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 36c7765..601253d 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 ## [v0.2.0](https://github.com/andreskrey/readability.php/releases/tag/v0.2.0) @@ -1,7 +1,7 @@ # Readability.php [](https://packagist.org/packages/andreskrey/readability.php) [](https://styleci.io/repos/71042668) [](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 |