diff --git a/doc.go b/doc.go index 44f2a7d..5923983 100644 --- a/doc.go +++ b/doc.go @@ -1,4 +1,4 @@ -// Package store provides SQLite-backed storage for grouped entries, TTL expiry, +// Package store provides SQLite-backed key-value storage for grouped entries, TTL expiry, // namespace isolation, quota enforcement, reactive change notifications, // workspace journalling, and explicit orphan recovery. // diff --git a/store.go b/store.go index 96d197f..d796704 100644 --- a/store.go +++ b/store.go @@ -72,6 +72,8 @@ func (journalConfig journalConfiguration) isConfigured() bool { journalConfig.bucketName != "" } +// Store is the SQLite key-value store with optional journal backing. +// // Usage example: `storeInstance, err := store.New(":memory:")` type Store struct { sqliteDatabase *sql.DB