docs(): update project description

This commit is contained in:
Ryan Schmukler 2016-08-08 21:27:48 -04:00
parent 23c36ab9f2
commit e36964168e
1 changed files with 3 additions and 10 deletions

View File

@ -1,19 +1,12 @@
# Rox
Elixir wrapper around
[leo-project/erocksdb](https://github.com/leo-project/erocksdb)
[leo-project/erocksdb](https://github.com/leo-project/erocksdb) providing
RocksDB as NIFs to Elixir
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add `rox` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:rox, "~> 0.1.0"}]
end
```
Slow down there cow-boy. This library is still a WIP.
## Features