Prepare for v0.2.0.

README.md

@@ -58,7 +58,7 @@ As a library, you can add this stanza to your `Cargo.yaml`:
 
 ```
 [dependencies]
-libknox = "^0.1.1"
+libknox = "^0.2.0"
 ```
 
 ## Create the vault

knox/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "knox"
-version = "0.1.3"
+version = "0.2.0"
 description = "structured secret vault encrypted through GPG"
 authors = ["Antoine POPINEAU <antoine.popineau@appscho.com>"]
 repository = "https://github.com/apognu/knox"
@@ -18,7 +18,7 @@ path = "src/main.rs"
 knox_testing = { path = "../knox-testing" }
 
 [dependencies]
-libknox = { version = "^0.1", path = "../libknox" }
+libknox = { version = "^0.2", path = "../libknox" }
 log = "^0.4"
 pretty_env_logger = "^0.2"
 clap = { version = "^2.0", features = ["yaml"] }

libknox/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "libknox"
-version = "0.1.1"
+version = "0.2.0"
 description = "secret vault encrypted with GPG"
 authors = ["Antoine POPINEAU <antoine.popineau@appscho.com>"]
 repository = "https://github.com/apognu/knox"

libknox/README.md

@@ -0,0 +1,44 @@
+# libknox
+
+`libknox` is the library behing the [knox](https://crates.io/crates/knox) secret manager.
+
+You can refer to the [repository](https://github.com/apognu/knox) or the [documentation](https://docs.rs/libknox/) for usage information.
+
+## Example
+
+```
+use libknox::*;
+
+fn main() {
+  // Create a new vault with the given GPG identity
+  let id = vec!["vault-test@apognu.github.com".to_string()];
+  let mut vault = VaultContext::create("/tmp/knox-example", &id).expect("FAIL");
+
+  // Create a new entry with three attributes
+  let mut entry = Entry::new();
+  entry.add_attribute("username", "bob");
+  entry.add_confidential_attribute("password", "foobar");
+  entry.add_confidential_attribute(
+    "apikey",
+    "3OJL07P+W5zODH2J1Wv7rXh5i9UpR0mpvPW7ygIMih82J8P95krJZXyERqbi/XS",
+  );
+
+  // Write the entry and the metadata pointing to it
+  vault
+    .write_entry("personal/website.com", &entry)
+    .expect("FAIL");
+
+  // Open the previously created vault and read the written entry
+  let vault = VaultContext::open("/tmp/knox-example").expect("FAIL");
+  let entry = vault.read_entry("personal/website.com").expect("FAIL");
+
+  // Loop over the attributes and print them
+  for (key, attribute) in entry.get_attributes() {
+    if attribute.confidential {
+      println!("{} = {} (CONFIDENTIAL)", key, attribute.value);
+    } else {
+      println!("{} = {}", key, attribute.value);
+    }
+  }
+}
+```