Skip to content

Commit

Permalink
update readme to include examples list
Browse files Browse the repository at this point in the history
  • Loading branch information
notrab committed Oct 16, 2024
1 parent adf1daa commit 8264a0c
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions packages/libsql-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,19 @@ await turso.execute({
});
```

## Examples

| Example | Description |
| ------------------------------------- | --------------------------------------------------------------------------------------- |
| [local](examples/local) | Uses libsql with a local SQLite file. Creates database, inserts data, and queries. |
| [remote](examples/remote) | Connects to a remote database. Requires environment variables for URL and auth token. |
| [sync](examples/sync) | Demonstrates synchronization between local and remote databases. |
| [batch](examples/batch) | Executes multiple SQL statements in a single batch operation. |
| [transactions](examples/transactions) | Shows transaction usage: starting, performing operations, and committing/rolling back. |
| [memory](examples/memory) | Uses an in-memory SQLite database for temporary storage or fast access. |
| [vector](examples/vector) | Works with vector embeddings, storing and querying for similarity search. |
| [encryption](examples/encryption) | Creates and uses an encrypted SQLite database, demonstrating setup and data operations. |

## Documentation

Visit our [official documentation](https://docs.turso.tech/sdk/kotlin).
Expand Down

0 comments on commit 8264a0c

Please sign in to comment.