From 68b031254dc1fd2a38f0d35315a422d367c24a1f Mon Sep 17 00:00:00 2001 From: Vincent Rischmann Date: Fri, 30 Oct 2020 00:04:17 +0100 Subject: update readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 2174697..3301da1 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,11 @@ This package is a thin wrapper around [sqlite](https://sqlite.org/index.html)'s * `libsqlite3-dev` for Debian and derivatives * `sqlite3-devel` for Fedora +## Features + +* Preparing, executing statements +* comptime checked bind parameters + ## Installation Since there's no package manager for Zig yet, the recommended way is to use a git submodule: @@ -118,3 +123,9 @@ Here are the resules for resultset rows: * `TEXT` can be read into a `[]const u8` or `[]u8`. * `TEXT` can be read into any array of `u8` provided the data fits. * `BLOB` follows the same rules as `TEXT`. + +### Comptime checked statements + +Prepared statements contain _comptime_ metadata which is used to validate that every call to `exec`, `one` and `all` provides the appropriate number of bind parameters. + +Right now there's no _type_ checking of bind parameters but it could probably be done. -- cgit v1.2.3