summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichal Čihař <michal@cihar.com>2016-03-07 16:20:03 +0100
committerMichal Čihař <michal@cihar.com>2016-03-07 16:20:03 +0100
commitba604eff3e2e6ca8bf9d6005e65cdad4d82345f9 (patch)
tree9f3ef1023b3312b28d80e73fec37f0323409a54b
parentad0e75faa6f6943d013f23d0d1ca31b4781e7b79 (diff)
downloadsql-parser-ba604eff3e2e6ca8bf9d6005e65cdad4d82345f9.zip
sql-parser-ba604eff3e2e6ca8bf9d6005e65cdad4d82345f9.tar.gz
sql-parser-ba604eff3e2e6ca8bf9d6005e65cdad4d82345f9.tar.bz2
Add at least some basic examples to README
Issue #42 Signed-off-by: Michal Čihař <michal@cihar.com>
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
index cef1540..3a1108c 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,37 @@ A validating SQL lexer and parser with a focus on MySQL dialect.
[![codecov.io](https://codecov.io/github/phpmyadmin/sql-parser/coverage.svg?branch=master)](https://codecov.io/github/phpmyadmin/sql-parser?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phpmyadmin/sql-parser/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phpmyadmin/sql-parser/?branch=master)
+## Installation
+
+Please use [Composer][1] to install:
+
+```
+composer require phpmyadmin/sql-parser
+```
+
+## Usage
+
+### Formatting SQL query
+
+```php
+echo SqlParser\Utils\Formatter::format($query, array('type' => 'html');
+```
+
+### Parsing and building SQL query
+
+```php
+$parsed = new SqlParser\Parser($query);
+
+// you can now inspect or change query
+var_dump($parser->statements[0]);
+
+// and build it again
+$statement = $parser->statements[0];
+$statement->build()
+```
+
## More information
This library was originally during the Google Summer of Code 2015 and has been used by phpMyAdmin since version 4.5.
+
+[1]:https://getcomposer.org/