Install FDB synchronously
[couchdb-erlfdb.git] / README.md
index 49beb3195142bad914d9fc349c6e5dae88d1876f..2d9522488c33ae9317df6a8b839e5985f6626993 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 An Erlang Binding to FoundationDB
 ===
 
+[![CI](https://github.com/apache/couchdb-erlfdb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/couchdb-erlfdb/actions/workflows/ci.yml)[![Coverage](https://coveralls.io/repos/github/apache/couchdb-erlfdb/badge.svg?branch=main)](https://coveralls.io/github/apache/couchdb-erlfdb?branch=main)
+
 This project is a NIF wrapper for the FoundationDB C API. Documentation on
 the main API can be found [here][fdb_docs].
 
@@ -46,4 +48,11 @@ ok
 <<"bar">>
 4> erlfdb:get(Db, <<"bar">>).
 not_found
-```
\ No newline at end of file
+```
+
+Binding Tester
+---
+
+FoundationDB has a custom binding tester that can be used to test whether
+changes have broken compatibility. See the [BINDING_TESTER](BINDING_TESTER.md)
+documentation for instructions on building and running that system.
\ No newline at end of file