Initial commit
This commit is contained in:
21
readme.md
Normal file
21
readme.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# shanty-db
|
||||
|
||||
Shared database schema and access layer for [Shanty](ssh://connor@git.rcjohnstone.com:2222/Shanty/shanty.git).
|
||||
|
||||
Uses Sea-ORM with SQLite. Provides migrations, typed entities, connection pooling,
|
||||
and query functions used by all other Shanty crates.
|
||||
|
||||
## Usage
|
||||
|
||||
```rust
|
||||
use shanty_db::Database;
|
||||
|
||||
let db = Database::new("sqlite:///path/to/shanty.db?mode=rwc").await?;
|
||||
// use db.conn() for queries
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
|
||||
```sh
|
||||
cargo test
|
||||
```
|
||||
Reference in New Issue
Block a user