Skip to content

Commit 6df205f

Browse files
Updated docs
1 parent f7fdd49 commit 6df205f

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,13 @@ This option (`'live'`) enables minification of the html responses just before th
6767

6868
## Usage
6969

70-
**Getting Started**
71-
72-
The class of most interest is `Classes\HTMLMin`. It is bound to the ioc container as `'htmlmin'` and can be accessed using the `Facades\HTMLMin` facade.
73-
7470
**Classes\HTMLMin**
7571

76-
There are three public methods of interest.
72+
This is the class of most interest It is bound to the ioc container as `'htmlmin'` and can be accessed using the `Facades\HTMLMin` facade. There are three public methods of interest.
7773

7874
The `'blade'` method will parse a string as blade and minify it as quickly as possible. This is method the compiler class uses when blade minification is enabled.
7975

80-
The `'render'` method will parse a string as html and will minify it as best as possible using Mr Clay's [Minify](https://github.com/mrclay/minify) package. This method can be more time consuming than the blade method, but will usually achieve an overall smaller result. This is the method that is used in an after filter when live minification is enabled.
76+
The `'render'` method will parse a string as html and will minify it as best as possible using Mr Clay's [Minify](https://github.com/mrclay/minify) package. This method can be more time consuming than the blade method, but will usually achieve an overall smaller result. This is the method that is automatically used in an after filter when live minification is enabled.
8177

8278
The `'make'` method will return a minified view after being parsed by the `'blade'` method. Note that the minification occurs after the view has been executed unlike in the compiler where the view is minified and cached before it is executed.
8379

@@ -87,11 +83,11 @@ This class contains no public methods of interest. This class used to minify bla
8783

8884
**Facades\HTMLMin**
8985

90-
This facade will dynamically pass static method calls to the `'htmlmin'` object in the ioc container which by default is the `'Classes\HTMLMin'` class.
86+
This facade will dynamically pass static method calls to the `'htmlmin'` object in the ioc container which by default is the `Classes\HTMLMin` class.
9187

9288
**HTMLMinServiceProvider**
9389

94-
This class contains no public methods of interest. This class should be added to the providers array in `'app/config/app.php'`. This class will setup ioc bindings and register automatic blade/live minification based on the config.
90+
This class contains no public methods of interest. This class should be added to the providers array in `app/config/app.php`. This class will setup ioc bindings and register automatic blade/live minification based on the config.
9591

9692
**Further Information**
9793

0 commit comments

Comments
 (0)