Skip to content

Commit fa00ac7

Browse files
committed
added travis and coveralls badges
added composer installation instructions
1 parent 1134321 commit fa00ac7

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# SQLParser - Parse MySQL schemas in PHP, fast
22

3+
[![Build Status](https://travis-ci.org/iamcal/SQLParser.svg?branch=master)](https://travis-ci.org/iamcal/SQLParser)
4+
[![Coverage Status](https://coveralls.io/repos/github/iamcal/SQLParser/badge.svg?branch=master)](https://coveralls.io/github/iamcal/SQLParser?branch=master)
5+
36
This library was created to parse multiple `CREATE TABLE` schemas and compare them, so
47
figure out what needs to be done to migrate one to the other.
58

@@ -9,6 +12,27 @@ just showed a diff (see [SchemaDiff](https://github.com/iamcal/SchemaDiff)), but
912
of a pain.
1013

1114

15+
## Installation
16+
17+
You can install this package using composer. To add it to your `composer.json`:
18+
19+
composer require iamcal/sql-parser
20+
21+
You can then load it using the composer autoloader:
22+
23+
require_once 'vendor/autoload.php';
24+
use iamcal\SQLParser;
25+
26+
$parser = new SQLParser();
27+
28+
If you don't use composer, you can skip the autoloader and include `src/SQLParser.php` directly.
29+
30+
31+
## Usage
32+
33+
TODO
34+
35+
1236
## Performance
1337

1438
My test target is an 88K SQL file containing 114 tables from Glitch's main database.

0 commit comments

Comments
 (0)