nim-sqlcipher/README.md
Michael Bradley, Jr 20d2843dfb
refactor: adapt repo to use the nimbus-build-system
An important aspect of this refactor is that a user of this library needs to
supply openssl with respect to building the `sqlite3.c` amalgamation and the
`sqlite.nim` wrapper.
2020-10-15 18:18:37 -05:00

38 lines
1.1 KiB
Markdown

# nim-sqlcipher
[![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)
[![Tests (GitHub Actions)](https://github.com/status-im/nim-sqlcipher/workflows/Tests/badge.svg?branch=master)](https://github.com/status-im/nim-sqlcipher/actions?query=workflow%3ATests+branch%3Amaster)
A nim wrapper for the [SQLCipher](https://github.com/sqlcipher/sqlcipher).
It builds SQLCipher and provides a simple API based on the [Tiny_SQLite](https://github.com/GULPF/tiny_sqlite) nimble package
## Requirements
```
# Linux
sudo apt install libssl-dev
# MacOS
brew install openssl
# Windows
¯\_(ツ)_/¯
```
## Usage
TODO
## License
### Wrapper License
This repository is licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
### Dependency Licenses
- SQLCipher https://github.com/sqlcipher/sqlcipher/blob/master/LICENSE
- OpenSSL https://github.com/openssl/openssl/blob/master/LICENSE
- TinySQLite https://github.com/GULPF/tiny_sqlite/blob/master/LICENSE