status-im
/
nim-rocksdb
mirror of https://github.com/status-im/nim-rocksdb.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-rocksdb/README.md

47 lines
2.0 KiB
Markdown
Raw Normal View History

initial commit
2018-01-27 10:34:54 +00:00
# Nim-RocksDB
readme: fix license, badges
2018-09-05 05:02:57 +00:00
[![Build Status (Travis)](https://img.shields.io/travis/status-im/nim-rocksdb/master.svg?label=Linux%20/%20macOS "Linux/macOS build status (Travis)")](https://travis-ci.org/status-im/nim-rocksdb)
[![Windows build status (Appveyor)](https://img.shields.io/appveyor/ci/nimbus/nim-rocksdb/master.svg?label=Windows "Windows build status (Appveyor)")](https://ci.appveyor.com/project/nimbus/nim-rocksdb)
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
initial commit
2018-01-27 10:34:54 +00:00
A Nim wrapper for [Facebook's RocksDB](https://github.com/facebook/rocksdb), a persistent key-value store for Flash and RAM Storage.
Add nim-rocksdb usage example
2018-01-27 16:01:14 +00:00
## Current status
Nim-RocksDB currently provides a wrapper for the low-level functions of RocksDB
use dynamic linking instead of dlopen on all Linux distros - also document the need for "librocksdb-dev" on Debian
2018-12-25 10:56:20 +00:00
## Requirements
A RocksDB installation that provides `librocksdb.so`. This means that on Debian, and possibly on other Linux distros, you need "librocksdb-dev", not just a versioned "librocksdbX.Y" package that only provides `librocksdb.so.X.Y.Z`.
Add nim-rocksdb usage example
2018-01-27 16:01:14 +00:00
## Usage
See [simple_example](examples/simple_example.nim)
## Future directions
In the future, Nim-RocksDB might provide a high-level API that:
- is more in line with Nim conventions (types in CamelCase),
- automatically checks for errors,
- leverage Nim features like destructors for automatic resource cleanup.
initial commit
2018-01-27 10:34:54 +00:00
### Contribution
Any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any
remove example from README - linked code is more recent
2018-08-16 19:13:34 +00:00
additional terms or conditions.
readme: fix license, badges
2018-09-05 05:02:57 +00:00
## License
readme: update license
2018-09-05 18:48:31 +00:00
Licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
Update README.md
2019-01-02 13:57:34 +00:00
or
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
readme: fix license, badges
2018-09-05 05:02:57 +00:00
Update README.md
2019-01-02 13:57:34 +00:00
at your option. This file may not be copied, modified, or distributed except according to those terms.