Skip to content

Commit 1029ee0

Browse files
committed
Improving doc
1 parent 378debc commit 1029ee0

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Magic-query is a PHP library that helps you work with complex SQL queries.
1212

1313
It comes with 2 great features:
1414

15-
- [it helps you work with that require a variable number of parameters.](#parameters)
15+
- [**MagicParameters**: it helps you work with SQL queries that require a variable number of parameters.](#parameters)
1616
- [**MagicJoin**: it writes JOINs for you!](#joins)
1717

1818
Installation
@@ -31,8 +31,8 @@ Simply use the composer package:
3131
```
3232

3333
<a name="parameters"></a>
34-
Automatically discard unused parameters
35-
---------------------------------------
34+
Automatically discard unused parameters with MagicParameters
35+
------------------------------------------------------------
3636

3737
Just write the query with all possible parameters.
3838

@@ -55,7 +55,7 @@ $result2 = $magicQuery->build($sql, []);
5555
// The whole WHERE condition disappeared because it is not needed anymore!
5656
```
5757

58-
Curious to know how this work? <a class="btn btn-primary" href="doc/discard_unused_parameters.md">Check out the complete guide!</a>
58+
Curious to know how this work? <a class="btn btn-primary btn-large" href="doc/discard_unused_parameters.md">Check out the parameters guide!</a>
5959

6060
<a name="joins"></a>
6161
Automatically guess JOINs with MagicJoin!
@@ -104,7 +104,7 @@ $completeSql = $magicQuery->build($sql);
104104
// $completeSql contains the complete SQL request, with all joins.
105105
```
106106

107-
Want to know more? <a class="btn btn-primary" href="doc/magic_join.md">Check out the MagicJoin guide!</a>
107+
Want to know more? <a class="btn btn-primary btn-large" href="doc/magic_join.md">Check out the MagicJoin guide!</a>
108108

109109
Is it a MySQL only tool?
110110
------------------------

composer.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,17 @@
4747
},
4848
"extra": {
4949
"mouf": {
50-
"logo": "database.png"
50+
"logo": "database.png",
51+
"doc": [
52+
{
53+
"title": "MagicParameters: automatically discard unused parameters",
54+
"url": "doc/discard_unused_parameters.html"
55+
},
56+
{
57+
"title": "MagicJoin: let MagicQuery write JOINs for you",
58+
"url": "doc/magic_join.md"
59+
}
60+
]
5161
}
5262
},
5363
"minimum-stability": "dev",

0 commit comments

Comments
 (0)