feat(readme): update

Author: danielebriggi

.devcontainer/devcontainer.json

@@ -9,7 +9,8 @@
 	"customizations": {
 		"vscode": {
 			"extensions": [
-				"eamodio.gitlens"
+				"eamodio.gitlens",
+				"golang.go"
 			]
 		}
 	}

MAKEFILE.md

@@ -1,4 +1,4 @@
-# SQLite Cloud go-sdk Makefile
+# SQLite Cloud sqlitecloud-go Makefile
 
 ### Run the test for the SDK
 If you want to run the Test programs: `make test`

Makefile

@@ -3,6 +3,9 @@ GOPATH		= $(shell go env GOPATH)
 setup-ide:
 	pre-commit install
 	go install golang.org/x/tools/cmd/goimports@latest
+	go mod tidy
+	cd test; go mod tidy
+	cd cli; go mod tidy
 
 # Test SDK
 test:

README.md

@@ -1,11 +1,31 @@
 
-# SQLite Cloud Client SDK for Go v1.0.2
+# Driver for SQLite Cloud
 
-The SQLite Cloud Client SDK for Go (sqlitecloud/go-sdk) is the Go Programming Language application programmer's interface to [SQLite Cloud](https://sqlitecloud.io/). It is a set of library functions that allow client programs to pass queries and SQL commands to the SQLite Cloud backend server and to receive the results of these queries. In addition to the standard SQLite statements, several other [commands](https://docs.sqlitecloud.io/docs/commands) are supported.
+<p align="center">
+  <img src="https://sqlitecloud.io/social/logo.png" height="300" alt="SQLite Cloud logo">
+</p>
 
-## Getting Started
+- [Driver for SQLite Cloud](#driver-for-sqlite-cloud)
+- [Example](#example)
+- [Get a Connection String](#get-a-connection-string)
+- [Setting up the IDE](#setting-up-the-ide)
 
-### Use the SQLite Cloud Client SDK in your Go code
+[![Test and QA](https://github.com/sqlitecloud/sqlitecloud-go/actions/workflows/testing.yaml/badge.svg?branch=main)](https://github.com/sqlitecloud/sqlitecloud-go/actions/workflows/testing.yaml)
+[![codecov](https://codecov.io/gh/sqlitecloud/sqlitecloud-go/graph/badge.svg?token=5MAG3G4X01)](https://codecov.io/gh/sqlitecloud/sqlitecloud-go)
+[![GitHub Tag](https://img.shields.io/github/v/tag/sqlitecloud/sqlitecloud-go?label=version&link=https%3A%2F%2Fpkg.go.dev%2Fgithub.com%2Fsqlitecloud%2Fsqlitecloud-go)](https://github.com/sqlitecloud/sqlitecloud-go)
+[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/sqlitecloud/sqlitecloud-go?link=https%3A%2F%2Fgithub.com%2Fsqlitecloud%2Fsqlitecloud-go)](https://github.com/sqlitecloud/sqlitecloud-go)
+
+---
+
+[SQLite Cloud](https://sqlitecloud.io) for Go is a powerful package that allows you to interact with the SQLite Cloud database seamlessly. It provides methods for various database operations. This package is designed to simplify database operations in Go applications, making it easier than ever to work with SQLite Cloud. In addition to the standard SQLite statements, several other [commands](https://docs.sqlitecloud.io/docs/commands) are supported.
+
+- Documentation: https://pkg.go.dev/github.com/sqlitecloud/sqlitecloud-go
+- Source: [https://github.com/sqlitecloud/sqlitecloud-go](https://github.com/sqlitecloud/sqlitecloud-go)
+- Site: [https://sqlitecloud.io](https://sqlitecloud.io/developers)
+
+## Example
+
+### Use SQLite Cloud in your Go code
 
 1. Import the package in your Go source code:
 
@@ -15,7 +35,7 @@ The SQLite Cloud Client SDK for Go (sqlitecloud/go-sdk) is the Go Programming La
 
 2. Download the package, and run the [`go mod tidy` command](https://go.dev/ref/mod#go-mod-tidy) to synchronize your module's dependencies:
 
-    ```
+    ```bash
     $ go mod tidy
     go: downloading github.com/sqlitecloud/sqlitecloud-go v1.0.0
     ```
@@ -65,7 +85,7 @@ func main() {
 }
 ```
 
-## Get a connection string
+## Get a Connection String
 
 You can connect to any cloud database using a special connection string in the form:
 
@@ -79,6 +99,16 @@ To get a valid connection string, follow these instructions:
 - Get the connection string by clicking on the node address in the [Dashboard Nodes](https://docs.sqlitecloud.io/docs/introduction/nodes) section. A valid connection string will be copied to your clipboard.
 - Add the database name to your connection string.
 
-## API Documentation
 
-The complete documentation of the sqlitecloud/go-sdk library is available at: https://pkg.go.dev/github.com/sqlitecloud/sqlitecloud-go
+
+## Setting up the IDE
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+
+To start working on this project, follow these steps:
+
+1. Open the project folder in Visual Studio Code (VSCode) using the remote container feature.
+2. In the terminal, run the command `make setup-ide` to install the necessary development tools.
+3. To ensure code quality, we have integrated [pre-commit](https://github.com/pre-commit/pre-commit) into the workflow. Before committing your changes to Git, pre-commit will run several tasks defined in the `.pre-commit-config.yaml` file.
+
+By following these steps, you will have a fully set up development environment and be ready to contribute to the project.