diff --git a/README.md b/README.md index ac1dcfe..6c2f7b5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # mssql -Microsoft SQL server adapter for REL + +[![GoDoc](https://godoc.org/github.com/go-rel/mssql?status.svg)](https://pkg.go.dev/github.com/go-rel/mssql) +[![Integration](https://github.com/go-rel/mssql/actions/workflows/integration.yml/badge.svg?branch=main)](https://github.com/go-rel/mssql/actions/workflows/integration.yml) +[![Go Report Card](https://goreportcard.com/badge/github.com/go-rel/mssql)](https://goreportcard.com/report/github.com/go-rel/mssql) +[![Gitter chat](https://badges.gitter.im/go-rel/rel.png)](https://gitter.im/go-rel/rel) + +Microsoft SQL Server adapter for REL. + +## Example +```go +// open mssql connection. +adapter, err := mssql.Open("sqlserver://sa:REL2021-mssql@localhost:1433?database=rel") +if err != nil { + panic(err) +} +defer adapter.Close() + +// initialize REL's repo. +repo := rel.New(adapter) +``` + + +## Supported Database + +- Microsoft SQL Server 2017 +- Microsoft SQL Server 2019 diff --git a/mssql.go b/mssql.go index f1c2ed0..eb959d8 100644 --- a/mssql.go +++ b/mssql.go @@ -2,12 +2,11 @@ // // Usage: // // open mssql connection. -// adapter, err := mssql.Open("root@(127.0.0.1:3306)/rel_test?charset=utf8&parseTime=True&loc=Local") +// adapter, err := mssql.Open("sqlserver://sa:REL2021-mssql@localhost:1433?database=rel") // if err != nil { // panic(err) // } // defer adapter.Close() -// // // initialize REL's repo. // repo := rel.New(adapter) package mssql