Skip to content

Commit 9b22e88

Browse files
authored
Update README.md
1 parent 5ef4c5d commit 9b22e88

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# :hatching_chick: PromiseSQL
2-
A lightweight module for running simple, promise-based SQLite3 queries in node.js. It works best in smaller projects with a lot of asynchronous development, e.g., a Discord bot that implements slash commands.
2+
A [node-sqlite3](https://www.npmjs.com/package/sqlite3) wrapper for running simple, promise-based database queries in Node.js. It works best in smaller projects with a lot of asynchronous development, e.g., a Discord bot that implements slash commands.
33

44
```javascript
55
const db = require('promisesql');
@@ -18,7 +18,9 @@ db.open('./database.db');
1818
db.close();
1919
```
2020

21-
This module is still a work in progress. By design, it was created as an SQL backend for interaction-based Discord bots built in [discord.js v13](https://discord.js.org/#/docs/discord.js/v13/general/welcome). It is intended to create more user-friendly, asynchronous query functions on top of [node-sqlite3](https://www.npmjs.com/package/sqlite3), which take in an "options" object as arguments, a practice inspired by discord.js.
21+
***This module is still a work in progress.***
22+
23+
By design, it was created as an SQL backend for interaction-based Discord bots built in [discord.js v13](https://discord.js.org/#/docs/discord.js/v13/general/welcome). It is intended to create more user-friendly, asynchronous query functions, which take in an "options" object as arguments, a practice inspired by discord.js.
2224

2325
While it can run any query asychronously, it currently only supports the following built-in query and expression functions:
2426

0 commit comments

Comments
 (0)