Moduletrace/bun-sqlite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Benjamin Toby 2026-03-22 05:26:28 +01:00
parent e7ee76f572
commit 04e4e0e9fd
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -47,6 +47,16 @@ A schema-driven SQLite manager for [Bun](https://bun.sh), featuring automatic sc
## Prerequisites ## Prerequisites
This works for just `bun`, so `bun` should be installed.
---
## Installation
There are two ways to install BunSQLite:
### Via the official npm registry
`@moduletrace/bun-sqlite` is published to a private Gitea npm registry. You must configure your package manager to resolve the `@moduletrace` scope from that registry before installing. `@moduletrace/bun-sqlite` is published to a private Gitea npm registry. You must configure your package manager to resolve the `@moduletrace` scope from that registry before installing.
Add the following to your project's `.npmrc` file (create it at the root of your project if it doesn't exist): Add the following to your project's `.npmrc` file (create it at the root of your project if it doesn't exist):
@ -55,16 +65,20 @@ Add the following to your project's `.npmrc` file (create it at the root of your
@moduletrace:registry=https://git.tben.me/api/packages/moduletrace/npm/ @moduletrace:registry=https://git.tben.me/api/packages/moduletrace/npm/
``` ```
This works for both `bun` and `npm`. After this you can run
---
## Installation
```bash ```bash
bun add @moduletrace/bun-sqlite bun add @moduletrace/bun-sqlite
``` ```
### Via Github
To install directly from github simply run
```bash
bun add github:moduletrace/bun-sqlite
```
--- ---
## Quick Start ## Quick Start