Merge pull request #62 from CRBroughton/61-add-information-about-the-…

…supported-versions docs: 📝 update readme files with most recently tested dependency…
CRBroughton · Apr 12, 2024 · 48e7dc1 · 48e7dc1
2 parents d1e689f + 0866f6e
commit 48e7dc1
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,8 @@ If you choose to use Sibyl with `sql.js`, `sql.js` will provide the lower-level
 embedded SQLite database. You'll also need to install the `.wasm` file that `sql.js`
 provides; Please see their documentation at https://sql.js.org.
 
+The SQL.js implementation has been tested against SQL.js version 1.10.2.
+
 With the `.wasm` file now available, you can install Sibyl with the following command:
 
 ```bash
@@ -34,6 +36,8 @@ bun install @crbroughton/sibyl_bun
 Sibyl will then accept the native Bun SQLite `Database`, again, see the <a href="https://bun.sh/docs/api/sqlite">
 Bun documentation</a>.
 
+The Bun implementation has been tested against Bun version 1.1.3.
+
 #### libSQL Installation
 
 The libSQL implemenation of Sibyl can be installed
@@ -45,6 +49,8 @@ bun install @crbroughton/sibyl_libsql libsql
 Sibyl will then accept libSQL `Database`, then see the <a href="https://github.com/tursodatabase/libsql-js?tab=readme-ov-file#getting-started">
 libSQL Getting Started Guide</a>.
 
+The libSQL implementation has been tested against libSQL version 0.3.11.
+
 #### Getting Started
 
 To start off with Sibyl, you'll first have to ensure Sibyl is able to be run inside

diff --git a/src/bun/README.md b/src/bun/README.md
@@ -16,6 +16,8 @@ If you choose to use Sibyl with `sql.js`, `sql.js` will provide the lower-level
 embedded SQLite database. You'll also need to install the `.wasm` file that `sql.js`
 provides; Please see their documentation at https://sql.js.org.
 
+The SQL.js implementation has been tested against SQL.js version 1.10.2.
+
 With the `.wasm` file now available, you can install Sibyl with the following command:
 
 ```bash
@@ -34,6 +36,8 @@ bun install @crbroughton/sibyl_bun
 Sibyl will then accept the native Bun SQLite `Database`, again, see the <a href="https://bun.sh/docs/api/sqlite">
 Bun documentation</a>.
 
+The Bun implementation has been tested against Bun version 1.1.3.
+
 #### libSQL Installation
 
 The libSQL implemenation of Sibyl can be installed
@@ -45,6 +49,8 @@ bun install @crbroughton/sibyl_libsql libsql
 Sibyl will then accept libSQL `Database`, then see the <a href="https://github.com/tursodatabase/libsql-js?tab=readme-ov-file#getting-started">
 libSQL Getting Started Guide</a>.
 
+The libSQL implementation has been tested against libSQL version 0.3.11.
+
 #### Getting Started
 
 To start off with Sibyl, you'll first have to ensure Sibyl is able to be run inside
@@ -234,6 +240,19 @@ const updatedEntry = Update('firstTable', { // infers the table and response typ
    }
 })
 ```
+### Sorting
+
+Sibyl offers some basic sorting options, whenever you're returning
+entries from the database:
+
+```typescript
+const actual = All('firstTable', {
+  sort: {
+    name: 'ASC', // This can be 'ASC' or 'DESC'
+  },
+})
+```
+
 ### Primary type
 
 Sibyl offers a custom type, called the 'primary' type. When using

diff --git a/src/libsql/README.md b/src/libsql/README.md
@@ -16,6 +16,8 @@ If you choose to use Sibyl with `sql.js`, `sql.js` will provide the lower-level
 embedded SQLite database. You'll also need to install the `.wasm` file that `sql.js`
 provides; Please see their documentation at https://sql.js.org.
 
+The SQL.js implementation has been tested against SQL.js version 1.10.2.
+
 With the `.wasm` file now available, you can install Sibyl with the following command:
 
 ```bash
@@ -34,6 +36,8 @@ bun install @crbroughton/sibyl_bun
 Sibyl will then accept the native Bun SQLite `Database`, again, see the <a href="https://bun.sh/docs/api/sqlite">
 Bun documentation</a>.
 
+The Bun implementation has been tested against Bun version 1.1.3.
+
 #### libSQL Installation
 
 The libSQL implemenation of Sibyl can be installed
@@ -45,6 +49,8 @@ bun install @crbroughton/sibyl_libsql libsql
 Sibyl will then accept libSQL `Database`, then see the <a href="https://github.com/tursodatabase/libsql-js?tab=readme-ov-file#getting-started">
 libSQL Getting Started Guide</a>.
 
+The libSQL implementation has been tested against libSQL version 0.3.11.
+
 #### Getting Started
 
 To start off with Sibyl, you'll first have to ensure Sibyl is able to be run inside
@@ -234,6 +240,19 @@ const updatedEntry = Update('firstTable', { // infers the table and response typ
    }
 })
 ```
+### Sorting
+
+Sibyl offers some basic sorting options, whenever you're returning
+entries from the database:
+
+```typescript
+const actual = All('firstTable', {
+  sort: {
+    name: 'ASC', // This can be 'ASC' or 'DESC'
+  },
+})
+```
+
 ### Primary type
 
 Sibyl offers a custom type, called the 'primary' type. When using

diff --git a/src/sqljs/README.md b/src/sqljs/README.md
@@ -16,6 +16,8 @@ If you choose to use Sibyl with `sql.js`, `sql.js` will provide the lower-level
 embedded SQLite database. You'll also need to install the `.wasm` file that `sql.js`
 provides; Please see their documentation at https://sql.js.org.
 
+The SQL.js implementation has been tested against SQL.js version 1.10.2.
+
 With the `.wasm` file now available, you can install Sibyl with the following command:
 
 ```bash
@@ -34,6 +36,8 @@ bun install @crbroughton/sibyl_bun
 Sibyl will then accept the native Bun SQLite `Database`, again, see the <a href="https://bun.sh/docs/api/sqlite">
 Bun documentation</a>.
 
+The Bun implementation has been tested against Bun version 1.1.3.
+
 #### libSQL Installation
 
 The libSQL implemenation of Sibyl can be installed
@@ -45,6 +49,8 @@ bun install @crbroughton/sibyl_libsql libsql
 Sibyl will then accept libSQL `Database`, then see the <a href="https://github.com/tursodatabase/libsql-js?tab=readme-ov-file#getting-started">
 libSQL Getting Started Guide</a>.
 
+The libSQL implementation has been tested against libSQL version 0.3.11.
+
 #### Getting Started
 
 To start off with Sibyl, you'll first have to ensure Sibyl is able to be run inside
@@ -234,6 +240,19 @@ const updatedEntry = Update('firstTable', { // infers the table and response typ
    }
 })
 ```
+### Sorting
+
+Sibyl offers some basic sorting options, whenever you're returning
+entries from the database:
+
+```typescript
+const actual = All('firstTable', {
+  sort: {
+    name: 'ASC', // This can be 'ASC' or 'DESC'
+  },
+})
+```
+
 ### Primary type
 
 Sibyl offers a custom type, called the 'primary' type. When using