From b397e094f73fef9fc061d37c2146aeba62cfa4a1 Mon Sep 17 00:00:00 2001 From: Carlos Nieto <jose.carlos@menteslibres.net> Date: Thu, 10 Apr 2014 06:27:21 -0500 Subject: [PATCH] Updating README. --- sqlite/README.md | 59 ++++-------------------------------------------- 1 file changed, 4 insertions(+), 55 deletions(-) diff --git a/sqlite/README.md b/sqlite/README.md index 4d42812b..1c604de9 100644 --- a/sqlite/README.md +++ b/sqlite/README.md @@ -1,57 +1,6 @@ -# upper.io/db/sqlite +# SQLite3 adapter for upper.io/db -This is a wrapper of the [github.com/mattn/go-sqlite3][1] package by -[Yasuhiro Matsumoto][2]. - -Some changes had to be made to the original driver in order to work with -`upper.io/db`, such as removing data conversion features, you can see and -contribute to the forked repository at [github.com/xiam/gosqlite3][3]. - -## Installation - -First, make sure you can install [go-sqlite3][1] - -```go -# OSX -brew install pkg-config sqlite3 -# Debian -sudo apt-get install pkg-config libsqlite3-dev -# Getting the package -go get github.com/mattn/go-sqlite3 -``` - -If you succeed, installing the wrapper won't be any difficult. - -```go -go get upper.io/db/sqlite -``` - -## Usage - -Import [db][4] and [sqlite][3]. - -```go -import ( - "upper.io/db" - // Import the wrapper to the blank identifier. - _ "upper.io/db/sqlite" -) -``` - -Open a database file. - -```go -settings := db.Settings{ - Database: "./database.sqlite3", -} -sess, err := db.Open("sqlite", settings) -``` - -That's all! see the manual at [upper.io][4] for further documentation on -collections and how to create and query result sets. - -[1]: https://github.com/mattn/go-sqlite3 -[2]: http://mattn.kaoriya.net/ -[3]: https://github.com/xiam/gosqlite3 -[4]: https://upper.io +Please read the full docs, acknowledgements and examples at +[https://upper.io/db/sqlite][1] +[1]: https://upper.io/db/sqlite -- GitLab