From 1009af56aaa667290e276b92a017f1c80fc06b8a Mon Sep 17 00:00:00 2001
From: Stefan Behnel <stb@skoobe.de>
Date: Sun, 4 Jun 2017 23:03:09 +0200
Subject: [PATCH] mention Cython API in readme

---
 README.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 122af40..ed5e658 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,11 @@ FastRLock
 ---------
 
 This is a C-level implementation of a fast, re-entrant, optimistic lock for CPython.
-It is written in `Cython <http://cython.org>`_.
+It is a drop-in replacement for
+`threading.RLock <https://docs.python.org/3/library/threading.html#threading.RLock>`_.
+FastRLock is implemented in `Cython <http://cython.org>`_ and also provides a C-API
+for direct use from Cython code via ``from fastrlock cimport rlock``.
+
 Under normal conditions, it is about 10x faster than threading.RLock in Python 2.7
 because it avoids all locking unless two or more threads try to acquire it at the
 same time.  Under congestion, it is still about 10% faster than RLock due to being