Skip to content

Commit

Permalink
docs: clarify getSegments docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scriptcoded committed Aug 8, 2022
1 parent 20f4fa8 commit 97d911e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,10 @@ The following options may be passed to the `highlight` function.
}
```

**Get segments for custom highlighter**
## Custom highlighting

In case you want to do the highlighting yourself you can use `getSegments` to only let sql-highlight parse the SQL string for you. You can then use the segments to highlight it yourself.

```js
const { getSegments } = require('sql-highlight')

Expand Down

0 comments on commit 97d911e

Please sign in to comment.