status-im/nim-sqlcipher
2
0
Fork 0
mirror of https://github.com/status-im/nim-sqlcipher.git synced 2025-02-20 13:08:21 +00:00
Code Issues Projects Releases Wiki Activity

chore: update README

Browse Source 
More work remains to be done: the README should provide thorough instructions
re: building this repo's `Makefile` targets w.r.t. the
[nimbus-build-system](https://github.com/status-im/nimbus-build-system/).
This commit is contained in:
Michael Bradley, Jr 2021-01-30 15:33:48 -06:00
parent 99e9ed1734
commit cf0f42503b
No known key found for this signature in database
GPG Key ID: D0307DBCF21A9A58
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -3,8 +3,7 @@
![Stability: experimental](https://img.shields.io/badge/Stability-experimental-orange.svg) ![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) [![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). Nim wrapper for [SQLCipher](https://github.com/sqlcipher/sqlcipher). It builds SQLCipher and provides a simple API based on [tiny_sqlite](https://github.com/GULPF/tiny_sqlite).
It builds SQLCipher and provides a simple API based on the [Tiny_SQLite](https://github.com/GULPF/tiny_sqlite) nimble package
## Requirements ## Requirements
``` ```
@ -14,8 +13,8 @@ sudo apt install libssl-dev
# MacOS # MacOS
brew install openssl brew install openssl
# Windows # Windows (msys2)
¯\_(ツ)_/¯ pacman -S mingw-w64-x86_64-openssl
``` ```
## Usage ## Usage
@ -26,9 +25,7 @@ TODO
### Wrapper License ### Wrapper License
This repository is licensed and distributed under either of Licensed and distributed under the [MIT License](https://github.com/status-im/nim-sqlcipher/blob/master/LICENSE).
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
### Dependency Licenses ### Dependency Licenses