Skip to content

Commit b9e750e

Browse files
committed
Update README
1 parent 7db4b89 commit b9e750e

1 file changed

Lines changed: 11 additions & 24 deletions

File tree

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@ DOMPDFModule
33

44
Master: ![master](https://github.com/netiul/DOMPDFModule/workflows/Continuous%20Integration/badge.svg?branch=master)
55

6-
The DOMPDF module integrates the DOMPDF library with Zend Framework 2 with minimal effort on the consumer's end.
6+
The DOMPDF module integrates the DOMPDF library with Laminas with minimal effort on the consumer's end.
77

88
## Requirements
9-
- [Laminas](https://getlaminas.org/)
9+
- [Laminas](https://getlaminas.org/)
1010

1111
## Installation
1212
Installation of DOMPDFModule uses PHP Composer. For more information about
1313
PHP Composer, please visit the official [PHP Composer site](http://getcomposer.org/).
1414

1515
#### Installation steps
1616

17-
1. `cd my/project/directory`
18-
2. Add the module to the project by:
19-
17+
1. `cd my/project/directory`
18+
2. Add the module to the project by:
19+
2020
composer require netiul/dompdf-module
2121

22-
3. open `my/project/directory/config/application.config.php` and add the following key to your `modules`:
22+
3. open `my/project/directory/config/application.config.php` and add the following key to your `modules`:
2323

24-
```php
25-
'DOMPDFModule',
26-
```
24+
```php
25+
'DOMPDFModule',
26+
```
2727
#### Configuration options
2828
You can override options via the `dompdf_module` key in your local or global config files. See DOMPDFModule/config/module.config.php for config options.
2929

@@ -34,7 +34,7 @@ You can override options via the `dompdf_module` key in your local or global con
3434

3535
namespace Application\Controller;
3636

37-
use Zend\Mvc\Controller\AbstractActionController;
37+
use Laminas\Mvc\Controller\AbstractActionController;
3838
use DOMPDFModule\View\Model\PdfModel;
3939

4040
class ReportController extends AbstractActionController
@@ -67,23 +67,10 @@ So you want to contribute? Fantastic! Don't worry, it's easy. Local builds, test
6767
docker build -t dino/dompdf-module .
6868
docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app dino/dompdf-module
6969
```
70-
70+
7171
Super easy, right? Here's a quick walk through as to what's going on.
7272

7373
* `docker build -t dino/dompdf-module .` builds a docker image that will be used for each run (i.e. each time `docker run` is executed) and tags it with the name `dino/dompdf-module`.
7474
* `docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app dino/dompdf-module` runs the default build in a new Docker container derived from the image tagged `dino/dompdf-module`. The root of the project and PHP Composer cache volume are mounted so that artifacts generated during the build process are available to you on your local machine.
7575

7676
**Note:** You only need to run the first command once in order to build the image. The second command is what executes the build (build, tests, code quality checks, etc.).
77-
78-
### Other Supported PHP Versions
79-
By default, builds executed using Docker are done so using the [latest stable version of PHP](http://php.net/supported-versions.php). If you're adventurous you can execute builds against other [supported versions](http://php.net/supported-versions.php) of PHP.
80-
81-
**PHP 5.6**
82-
83-
```
84-
docker build --build-arg PHP_VERSION=5.6 --tag dino/dompdf-module-php56 .
85-
docker run -v composer-cache:/var/lib/composer -v ${PWD}:/opt/app dino/dompdf-module-php56
86-
```
87-
88-
## To-do
89-
- Add command line support.

0 commit comments

Comments
 (0)