Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 update readme files with most recently tested dependency… #62

Merged
merged 1 commit into from
Apr 12, 2024
Merged

docs: 📝 update readme files with most recently tested dependency… #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
19 changes: 19 additions & 0 deletions src/bun/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
19 changes: 19 additions & 0 deletions src/libsql/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
19 changes: 19 additions & 0 deletions src/sqljs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading