Skip to content
Permalink
Browse files
Adding a better README
  • Loading branch information
davisp committed Sep 25, 2019
1 parent d03c5d2 commit 055be31930a0796b2a49f3e6389db66d33c6844f
Showing 1 changed file with 47 additions and 2 deletions.
@@ -1,4 +1,49 @@
A FoundationDB client in Erlang
An Erlang Binding to FoundationDB
===

Yay!
This project is a NIF wrapper for the FoundationDB C API. Documentation on
the main API can be found [here][fdb_docs].

This project also provides a conforming implementation of the [Tuple] and
[Directory] layers.

[fdb_docs]: https://apple.github.io/foundationdb/api-c.html
[Tuple]: https://github.com/apple/foundationdb/blob/master/design/tuple.md
[Directory]: https://apple.github.io/foundationdb/developer-guide.html#directories


Building
---

Assuming you have installed the FoundationDB C API library, building erlfdb
is as simple as:

$ make

Alternatively, adding erlfdb as a rebar dependency should Just Work ®.


Documentation for installing FoundationDB can be found [here for macOS]
or [here for Linux].

[here for macOS]: https://apple.github.io/foundationdb/getting-started-mac.html
[here for Linux]: https://apple.github.io/foundationdb/getting-started-linux.html


Quick Example
---

A simple example showing how to open a database and read and write keys:

```erlang
Eshell V9.3.3.6 (abort with ^G)
1> Db = erlfdb:open(<<"/usr/local/etc/foundationdb/fdb.cluster">>).
{erlfdb_database,#Ref<0.2859661758.3941466120.85406>}
2> ok = erlfdb:set(Db, <<"foo">>, <<"bar">>).
ok
3> erlfdb:get(Db, <<"foo">>).
<<"bar">>
4> erlfdb:get(Db, <<"bar">>).
not_found
```

0 comments on commit 055be31

Please sign in to comment.