Skip to content

Commit 5159911

Browse files
committed
docs: update docs
1 parent 2f28977 commit 5159911

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
1-
# SQL syntax highlight
2-
> A simple and lightweight SQL syntax highlighting library written in pure JavaScript
1+
# sql-highlight
2+
> A simple and lightweight library for highlighting SQL queries written in pure
3+
> JavaScript
34
45
[![Tests Status][tests-badge]][tests-url]
56
[![Coverage Status][coveralls-badge]][coveralls-url]
67
[![NPM Version][npm-version-badge]][npm-url]
78
[![Downloads Stats][npm-downloads-badge]][npm-url]
89

910
## What's it all about?
10-
SQL Highlight is a small package that highlights SQL queries. It can output to
11+
sql-highlight is a small package that highlights SQL queries. It can output to
1112
both the terminal with Unicode escape sequences, as well as to normal HTML. Oh,
1213
and there are no external dependencies 😉
1314

1415
## Installation
1516

16-
Install via Yarn:
17+
sql-highlight is tested to work with Node.js 14, 16 and 18.
18+
19+
Install with Yarn:
1720
```bash
1821
yarn add sql-highlight
1922
```
20-
Install via NPM:
23+
Install with NPM:
2124
```bash
2225
npm install sql-highlight
2326
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "sql-highlight",
33
"version": "4.2.1",
4-
"description": "A simple and lightweight syntax highlighting library for SQL",
4+
"description": "A simple and lightweight library for highlighting SQL queries written in pure JavaScript",
55
"main": "lib/index.js",
66
"types": "./lib/index.d.ts",
77
"repository": {

0 commit comments

Comments
 (0)