payne8/libsqldb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add windows info to readme

Browse Source
This commit is contained in:
Mason Payne
2024-08-19 01:12:28 -06:00
parent 34541d687f
commit 74c70e6723
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
readme.md
View File

@ -7,10 +7,14 @@ Copy this repo to have a golang application that is already set up to work with
1. Copy this repo to your new project
2. Modify two files.
go.mod needs a new package name.
main.go needs to use the package name to import from `{{packageName}}/db`
* go.mod needs a new package name.
* main.go needs to use the package name to import from `{{packageName}}/db`
3. Set up your environment variables
LIBSQL_AUTH_TOKEN
LIBSQL_DATABASE_URL
* LIBSQL_AUTH_TOKEN
* LIBSQL_DATABASE_URL
## Windows?
This project is designed to use an embedded replica by default but Windows is not supported by libSQL. So this project has special build tags for Windows and sets up a libSQL remote driver. If your build target doesn't include Windows you can remote the file `db/remote-only.go`.