Skip to content
This repository has been archived by the owner on Mar 19, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ConnorRigby committed Aug 5, 2018
1 parent 4f24e3a commit 3aacd79
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions README.md
Expand Up @@ -4,20 +4,17 @@
[![Hex.pm](https://img.shields.io/hexpm/v/sqlitex.svg)](https://hex.pm/packages/sqlitex)
[![Hex.pm](https://img.shields.io/hexpm/dt/sqlitex.svg)](https://hex.pm/packages/sqlitex)

Sqlitex
=======
# Sqlitex

An Elixir wrapper around [esqlite](https://github.com/mmzeeman/esqlite). The main aim here is to provide convenient usage of sqlite databases.

Updated to 1.0
==============
# Updated to 1.0

With the 1.0 release we made just a single breaking change. `Sqlitex.Query.query` previously returned just the raw query results on success and `{:error, reason}` on failure.
This has been bothering us for a while so we changed it in 1.0 to return `{:ok, results}` on success and `{:error, reason}` on failure.
This should make it easier to pattern match on. The `Sqlitex.Query.query!` function has kept its same functionality of returning bare results on success and raising an error on failure.

Usage
=====
# Usage

The simple way to use sqlitex is just to open a database and run a query

Expand Down Expand Up @@ -66,9 +63,5 @@ Sqlitex.Server.query(Golf.DB,
ORDER BY g.played_at DESC LIMIT 10")
```

Plans
=====

I started this project mostly as a way to learn about Elixir.
Some other people have found it useful and have done the hard work to make it work with ecto [v1.X](https://github.com/jazzyb/sqlite_ecto) and [v2.X](https://github.com/scouten/sqlite_ecto2).
I'm not currently using this for any production-level projects, but I'm happy to continue maintaining it as long as people find it useful.
# Looking for Ecto?
Check out the [Sqlite Ecto2 adapter](https://github.com/Sqlite-Ecto/sqlite_ecto2)

0 comments on commit 3aacd79

Please sign in to comment.