Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronBernabeu committed Jun 4, 2020
1 parent c3762e7 commit 89af1c0
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,27 @@ Simple and lightweight parser for span names in APM transactions written in PHP.

## Installation

1) Install via [composer]
Install via [composer]

```shell script
composer require aaronidas/apm-sql-lexer
```
```shell script
composer require aaronidas/apm-sql-lexer
```

## How to use

```php
Signature::parse($query);
```
```php
Signature::parse($query);
```

Example:

```php
$spanName = Signature::parse('SELECT * FROM foo');
var_dump($spanName);
// output: SELECT FROM foo
```
```php
$spanName = Signature::parse('SELECT * FROM foo');
var_dump($spanName);
// output: SELECT FROM foo
```

##### Reference doc for development:
[Reference doc]: https://docs.google.com/document/d/1sblkAP1NHqk4MtloUta7tXjDuI_l64sT2ZQ_UFHuytA/edit#heading=h.549ltma0zvhu
[Reference doc](https://docs.google.com/document/d/1sblkAP1NHqk4MtloUta7tXjDuI_l64sT2ZQ_UFHuytA/edit#heading=h.549ltma0zvhu)

* PostgreSQL dollar quoting not implemented yet

0 comments on commit 89af1c0

Please sign in to comment.