From ba196e5127aedef7c54d7f763d9c67a32bfa34b2 Mon Sep 17 00:00:00 2001
From: Hunter Morris <hunter.morris@smarkets.com>
Date: Mon, 8 Aug 2011 18:02:23 +0100
Subject: [PATCH] Add NIF warning

---
 README.rst | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.rst b/README.rst
index 747fba3..2c8693d 100644
--- a/README.rst
+++ b/README.rst
@@ -50,6 +50,9 @@ application's environment:
   Specifies whether to use the NIF implementation (``'nif'``) or a
   pool of port programs (``'port'``). Defaults to ``'port'``.
 
+  `WARNING: the NIF implementation will block Erlang VM scheduler
+  threads and is not suitable for many applications.`
+
 ``pool_size``
   Specifies the size of the port program pool. Defaults to ``4``.