From fc2d08f50f8756f6e625c66bd2490dfd24878918 Mon Sep 17 00:00:00 2001 From: Maas-Maarten Zeeman Date: Mon, 21 Nov 2011 23:39:26 +0100 Subject: [PATCH] Working on the readme --- README | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README b/README index fad7a13..365b513 100644 --- a/README +++ b/README @@ -1,7 +1,20 @@ Esqlite -======== +===== An Erlang nif library for sqlite3. Introduction -------------- +----------------- + +This library allows you to use the accelent sqlite engine from +erlang. The library is implemented as a nif library, which allows for +the fastest access to a sqlite database. This can be risky, as a bug +in the nif library or the sqlite database can crash the entire Erlang +VM. If you do not want to take this risk, it is always possible to +access the sqlite nif from a separate erlang node. + +Special care has been taken not to block the scheduler of the calling +process. This is done by handling all commands from erlang within a +lightweight thread. The erlang scheduler will get control back when +the command has been added to the command-queue of the thread. +