From ba887b9f9f9c8efe3e2cf318c92afb782e93d4f5 Mon Sep 17 00:00:00 2001 From: Thierry Bela Date: Sun, 18 Sep 2022 09:01:45 -0400 Subject: [PATCH] #142 update documentation --- README.md | 20 ++++++++++++++++++-- docs/README.md | 26 ++++++++++++++++++++++++-- 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 08cca21b..4b5fae47 100755 --- a/README.md +++ b/README.md @@ -584,6 +584,19 @@ $stylesheet->append('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/ ## Performance +### Utility methods + +The renderer class provides utility methods to format css data + +```php + +$css = \TBela\CSS\Renderer::fromFile($url_or_file, $renderOptions = [], $parseOptions = []); +# +$css = \TBela\CSS\Renderer::fromString($css, $renderOptions = [], $parseOptions = []); +``` + +### Manual parsing and rendering + parsing and rendering ast is 3x faster than parsing an element. ```php @@ -598,9 +611,12 @@ echo (string) $parser; // or render minified css $renderer = new Renderer(['compress' => true]); -echo $renderer->renderAst($parser->getAst()); -// slower - will build an Element +echo $renderer->renderAst($parser); +# or +echo $renderer->renderAst($parser->getAst()); +# or +// slower - will build a stylesheet object echo $renderer->render($parser->parse()); ``` ## Parser Options diff --git a/docs/README.md b/docs/README.md index 539f8b22..4d3470a7 100755 --- a/docs/README.md +++ b/docs/README.md @@ -31,10 +31,16 @@ A CSS parser, beautifier and minifier written in PHP. It supports the following install using [Composer](https://getcomposer.org/) +### PHP version >= 8.0 ```bash $ composer require tbela99/css ``` +### PHP version >= 5.6 +```bash +$ composer require "tbela99/css:dev-php56-backport" +``` + ## Requirements - PHP version >= 8.0 on master branch. @@ -578,6 +584,19 @@ $stylesheet->append('https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/ ## Performance +### Utility methods + +The renderer class provides utility methods to format css data + +```php + +$css = \TBela\CSS\Renderer::fromFile($url_or_file, $renderOptions = [], $parseOptions = []); +# +$css = \TBela\CSS\Renderer::fromString($css, $renderOptions = [], $parseOptions = []); +``` + +### Manual parsing and rendering + parsing and rendering ast is 3x faster than parsing an element. ```php @@ -592,9 +611,12 @@ echo (string) $parser; // or render minified css $renderer = new Renderer(['compress' => true]); -echo $renderer->renderAst($parser->getAst()); -// slower - will build an Element +echo $renderer->renderAst($parser); +# or +echo $renderer->renderAst($parser->getAst()); +# or +// slower - will build a stylesheet object echo $renderer->render($parser->parse()); ``` ## Parser Options