Merge branch 'main' of https://github.com/akrouk/PromiseSQL

Author: akrouk

README.md

@@ -1 +1,50 @@
-# PromiseSQL
+# :hatching_chick: PromiseSQL
+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.
+
+```javascript
+const db = require('promisesql');
+db.open('./database.db');
+
+(async () => {
+  const data = await db.select({
+    all: true,
+    from: 'lorem',
+    where: [ db.expression.eq('ipsum', 'dolor') ]
+  });
+  
+  data.forEach(datum => console.log(datum.dolor));
+})();
+
+db.close();
+```
+
+***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, which take in an "options" object as arguments, a practice inspired by discord.js. 
+
+While it can run any query asychronously, it currently only supports the following built-in query and expression functions:
+
+## Queries
+
+### Insert
+`insert({ table: string, columns?: string[], values: string[])`
+```javascript
+const id = '123456789';
+const username = 'user99';
+
+await db.insert({
+  table: 'users',
+  columns: [ 'id', 'username' ],
+  values: [ id, username ]
+});
+```
+
+### Select
+### Update
+### Delete
+## Expressions
+  - Boolean
+  - Aggregate
+
+## Future plans
+Presently, there are no plans to add functionality such as creating tables, attaching databases, etc. For now, I handle operations like that with [DB Browser](https://sqlitebrowser.org/), which is a great tool for managing tables and data in small SQLite3 databases.