Skip to content

Commit 6b0441d

Browse files
Gappamabar
authored andcommitted
Update README.md
1 parent 99be3a6 commit 6b0441d

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

.docs/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818

1919
## Link Generator
2020

21-
There is a tiny extension which provides cachable LinkGenerator. LinkGenerator is a external service for creating
22-
URL addreses / links out of presenter scope. For example in mail templates.
21+
A tiny extension which provides cacheable LinkGenerator. LinkGenerator is an external service for creating
22+
URL addresses / links out of presenter scope, e.g. in mail templates.
2323

2424
```yaml
2525
extensions:
@@ -30,16 +30,16 @@ extensions:
3030
3131
### Presenter
3232
33-
Extending `BasePresenter` you can use these methods:
33+
By extending the `BasePresenter` you can use these methods:
3434

3535
| Methods | Return | Description |
3636
|---------|--------|-------------|
37-
| `isModuleCurrent($module)` | `boolean` | Is current presenter in given module? |
38-
| `getModuleName()` | `string` | Get current presenter module's name. |
37+
| `isModuleCurrent($module)` | `boolean` | Is the current presenter in a given module? |
38+
| `getModuleName()` | `string` | Get current presenter's module name. |
3939

4040
#### Structured Templates
4141

42-
Trait which modifies where are presenter templates located.
42+
A trait which modifies where the presenter templates are loaded from.
4343

4444
- Views
4545
- `%presenterDir%/templates/%view%.latte`
@@ -110,7 +110,7 @@ $presenter->sendResponse(new PSR7StreamResponse($stream, 'invoice.pdf', 'applica
110110

111111
There are 2 types of fly response:
112112

113-
- **FlyResponse** - For common purpose and your custom solutions.
113+
- **FlyResponse** - General purpose fly response.
114114
- **FlyFileResponse** - Special response for handling files on-the-fly.
115115

116116
### XmlResponse
@@ -123,13 +123,13 @@ $presenter->sendResponse(new XmlResponse($xml));
123123

124124
#### ProcessAdapter
125125

126-
Execute command over [popen](http://php.net/manual/en/function.popen.php).
126+
Execute a command over [popen](http://php.net/manual/en/function.popen.php).
127127

128128
```php
129129
use Contributte\Application\Response\Fly\Adapter\ProcessAdapter;
130130
use Contributte\Application\Response\Fly\FlyFileResponse;
131131
132-
// Compress current folder and send to response
132+
// Compress the current folder and send it to a response
133133
$adapter = new ProcessAdapter('tar cf - ./ | gzip -c -f');
134134
$response = new FlyFileResponse($adapter, 'folder.tgz');
135135

0 commit comments

Comments
 (0)