Skip to content
This repository has been archived by the owner on Sep 18, 2023. It is now read-only.

Commit

Permalink
Merge pull request #84 from deanblackborough/release
Browse files Browse the repository at this point in the history
Release
  • Loading branch information
deanblackborough authored Jun 2, 2018
2 parents a67557e + aa61c50 commit 5aabfd9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@

Full changelog for PHP Quill Renderer

## v3.12.0 - 2018-06-02

* Added new Interfaces, will simplify additional of new parsers.
* Initial Markdown development, not complete, no escaping yet and not fully tested.
* Reverted requirements to 7.1, turns out there isn't currently a hard requirement for 7.2.
* General refactoring, also, improved list handling.

## v3.11.0 - 2018-05-29

* `load()` and `loadMultple()` now support method chaining, closes #72, required
Expand Down
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

# PHP Quill Renderer

Render quill insert deltas to HTML and Markdown
Render quill insert deltas to HTML and Markdown (Markdown support still in testing)

## Description

Expand All @@ -21,29 +21,17 @@ Over the next few weeks/months I want to continue adding support for additional
output formats, after Markdown I'm planning on plain txt, GitHUb flavoured Markdown
and possible RTF/PDF.

## PHP < 7.2

Please use version v1.01.1 or v2.03.1 if you are using a version of PHP below 7.2,
versions 1 and 2 are not feature complete with version 3 and are unlikely to ever
be updated, the v3 code is so much more flexible, consider 1 and 2 unsupported.

## Installation

The easiest way to use the `PHP Quill Renderer` is via composer.
```composer require deanblackborough/php-quill-renderer```,
alternatively you can include the classes in my src/ directory directly in
your library or app.

### Legacy entry points

The `Render` and `RenderMultiple` classes are marked as deprecated, there is a
now a single entry point, `Quill`. The `Render` and `RenderMultiple` classes
will remain but should be considered legacy.

## Usage via API, single $quill_json
```
try {
$quill = new \DBlackborough\Quill\Render($quill_json, 'HTML');
$quill = new \DBlackborough\Quill\Render($quill_json);
$result = $quill->render();
} catch (\Exception $e) {
echo $e->getMessage();
Expand Down Expand Up @@ -137,3 +125,4 @@ List | `<ul>` `<ol>` | `* ` & `[n]`
* [Mark Davison](https://github.com/markdavison) - Pushed me in the right direction for v3.00.0
* [tominventisbe](https://github.com/tominventisbe) [Issue #54] v3.01.0 - Parser::load() does not reset the deltas array
* [tominventisbe](https://github.com/tominventisbe) [Issue #55] v3.01.0 - Image deltas with multiple attributes incorrectly being passed to Compound delta
* [bcorcoran](https://github.com/bcorcoran) [Issue #81] - Suggested reverting requirements to necessary requirements

0 comments on commit 5aabfd9

Please sign in to comment.