Skip to content

Commit dfe4359

Browse files
authored
Improve readme (#10)
1 parent 0efe3aa commit dfe4359

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ There just can be only single SqlWalker.
77
This library solves this issue, by providing `HintHandler` base class which is designed for SQL modification
88
and can be used multiple times in `$queryBuilder->setHint()`.
99

10+
### Installation:
11+
12+
```sh
13+
composer require shipmonk/doctrine-hint-driven-sql-walker
14+
```
15+
16+
### Usage:
17+
1018
```php
1119
$queryBuilder
1220
->setHint(Query::HINT_CUSTOM_OUTPUT_WALKER, HintDrivenSqlWalker::class)
@@ -41,8 +49,8 @@ class MaxExecutionTimeSqlWalker extends HintHandler
4149
}
4250
```
4351

44-
SqlNode is an enum of all walkXxx methods in Doctrine's SqlWalker, so you are able to intercept any part of AST processing the SqlWalker does.
52+
SqlNode is an enum of all `walkXxx` methods in Doctrine's SqlWalker, so you are able to intercept any part of AST processing the SqlWalker does.
4553

4654
### Implementors
47-
- shipmonk/doctrine-mysql-optimizer-hints (since v2)
48-
- shipmonk/doctrine-mysql-index-hints (since v3)
55+
- [shipmonk/doctrine-mysql-optimizer-hints](https://github.com/shipmonk-rnd/doctrine-mysql-optimizer-hints) (since v2)
56+
- [shipmonk/doctrine-mysql-index-hints](https://github.com/shipmonk-rnd/doctrine-mysql-index-hints) (since v3)

0 commit comments

Comments
 (0)