Update documentation for yaml integration

This commit is contained in:
Marcel Müller
2016-10-28 19:58:53 +02:00
parent 9d6a9b0582
commit be1d68890a
3 changed files with 19 additions and 1 deletions

View File

@@ -26,6 +26,7 @@ Features
- Simple To Use, Fast, Secure
- Threadsafe
- Key/Value Storage
- bincode or yaml storage
Usage
-----
@@ -55,6 +56,21 @@ fn main() {
}
```
### Yaml
If you would like to use yaml instead of bincode to perhaps read or modify the
database in an editor you can use it like this:
- Disable default features
- Specify yaml as a feature
```toml
[dependencies.rustbreak]
version = "1"
default-features = false
features = ["yaml"]
```
How it works
------------

View File

@@ -41,4 +41,6 @@ fn main() {
for al in get_albums("The Queenstons").unwrap() {
println!("{}", al);
}
DB.flush().unwrap();
}

View File

@@ -22,7 +22,7 @@
//! # Rustbreak
//!
//! Rustbreak is an [Daybreak][daybreak] inspiried single file Database.
//! It uses [bincode][bincode] to compactly save data.
//! It uses [bincode][bincode] or yaml to compactly save data.
//! It is thread safe and very fast due to staying in memory until flushed to disk.
//!
//! It can be used for short-lived processes or with long-lived ones: