From 960f858e7719392d40b3ad5456a78a34acf6c266 Mon Sep 17 00:00:00 2001 From: jake Date: Wed, 25 Jun 2025 10:45:35 -0400 Subject: [PATCH] adding readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..db87e64 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# lite +lite is a basic sqlite wrapper to provide basic configuration for use in Go apps + +
+ +## Dependencies +lite uses some established SQL libraries to provide easy sqlite connections +### Sqlite Driver +[ncruces](https://github.com/ncruces/go-sqlite3) is used to provide a compatible sqlite driver without cgo +### SQL Library +[sqlx](https://github.com/jmoiron/sqlx) is used to provide extensions on Go's standard SQL library + +
+ +## Defaults +lite is intended to be as simple as possible and provide the basic SQL functionality in less code, to do this lite has some default values. +### Filename +the database filename will default to "lite-db" unless changed with the WithName option +### Path +the database file path will default to the home directory unless changed with the WithPath option \ No newline at end of file