Skip to content

Commit

Permalink
feat(UnQLite): use official name as struct name
Browse files Browse the repository at this point in the history
  • Loading branch information
Huo Linhe committed May 13, 2016
1 parent c877df4 commit 65b647e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# unqlite

A high-level UnQlite database engine wrapper.
A high-level UnQLite database engine wrapper.

[![travis-badge][]][travis] [![release-badge][]][cargo] [![downloads]][cargo]
[![docs-badge][]][docs] [![license-badge][]][cargo]

NOTE: Some of the documents is stolen from [UnQlite Offical Website][unqlite].
NOTE: Some of the documents is stolen from [UnQLite Offical Website][unqlite].

## What is UnQlite?
## What is UnQLite?

>
UnQLite is a software library which implements a *self-contained*, *serverless*,
Expand All @@ -24,22 +24,22 @@ architectures.

## Port to Rust

This crate is high-level UnQlite database wrapper for Rust. A low-level bindings wrapper
This crate is high-level UnQLite database wrapper for Rust. A low-level bindings wrapper
is avaliable as a seperated crate: [unqlite-sys](https://crates.io/crates/unqlite-sys).

## Usage

You can start with `UnQlite` constructors:
You can start with `UnQLite` constructors:

```rust
extern crate unqlite;

use unqlite::{UnQlite, Config, KV, Cursor};
use unqlite::{UnQLite, Config, KV, Cursor};

fn main() {
// The database memory is not handled by Rust, and the database is on-disk,
// so `mut` is not neccessary.
let unqlite = UnQlite::create_temp();
let unqlite = UnQLite::create_temp();
// Use any type that can use as `[u8]`
unqlite.kv_store("key", "a long length value").unwrap();
unqlite.kv_store("abc", [1,2,3]).unwrap();
Expand Down

0 comments on commit 65b647e

Please sign in to comment.