Skip to content

Commit 5ed3843

Browse files
committed
improve readme
1 parent 51734b9 commit 5ed3843

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

logo.png

5.31 KB
Loading

readme.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
1-
### `sql`
1+
<img src="logo.png" alt="sql``" width="109" height="65"><br>
22

3-
_tag_ to format SQL \`template literals\`.
3+
### javascript template literals to format sql
44

55
Transforms a template literal in an object that can be read by [node-postgres](https://github.com/brianc/node-postgres).
66

7+
![version](https://badgen.net/npm/v/@sequencework/sql)
8+
![publish size](https://badgen.net/circleci/github/sequencework/sql)
9+
![publish size](https://badgen.net/packagephobia/install/@sequencework/sql)
10+
![publish size](https://badgen.net/packagephobia/publish/@sequencework/sql)
11+
712
### Features
813

9-
- Nested sql tags
10-
- `undefined` expressions are ignored
11-
- Useful [shorthand for node-postgres](#shorthand-fo-postgres) : sql(db)\`...\`
12-
- [TypeScript-friendly](#usage-with-typescript)
14+
- [Typescript friendly](#usage-with-typescript)
15+
- Lightweight (less than 50 lines of code)
16+
- Fully tested (100% coverage)
17+
- Works with **nested sql tags**
18+
- Works with **conditions inside expressions**
19+
- Compatible with [node-postgres](https://github.com/brianc/node-postgres), with a useful [shorthand](#shorthand-fo-postgres)
1320

1421
### Installation
1522

0 commit comments

Comments
 (0)