summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCody P Schafer <dev@codyps.com>2019-01-07 21:54:23 +0000
committerCody P Schafer <dev@codyps.com>2019-01-07 21:54:28 +0000
commit67176da74660b7e7f7165bee07ec9d63e33ea244 (patch)
tree665566bb6b71e580553a083087ec3ee58ec3fde1 /README.md
parent70fa2ba31f6fdb94d4459bcbfe50f7a15f0e6b65 (diff)
downloadrust-libzfs-67176da74660b7e7f7165bee07ec9d63e33ea244.zip
readme: add license, crates.io links, and docs.rs links
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 30 insertions, 1 deletions
diff --git a/README.md b/README.md
index cf102f0..83f64f7 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
# rust-libzfs
-Work with zfs filesystems using rust
+Rust APIs for zfs related interfaces. Currently: `libzfs_core` and `nvpair`.
+
+[![zfs-core crates.io](https://img.shields.io/badge/dynamic/json.svg?label=crates.io&url=https%3A%2F%2Fcrates.io%2Fapi%2Fv1%2Fcrates%2Fzfs-core%2Fversions&query=%24.versions.0.num&colorB=orange&prefix=zfs-core%20%3D%20%22&suffix=%22)](https://crates.io/crates/zfs-core)
+
+[![zfs-core docs.rs](https://img.shields.io/badge/documentation-release-brightgreen.svg?style=flat)](https://docs.rs/zfs-core/)
+
+[![zfs-core-sys crates.io](https://img.shields.io/badge/dynamic/json.svg?label=crates.io&url=https%3A%2F%2Fcrates.io%2Fapi%2Fv1%2Fcrates%2Fzfs-core-sys%2Fversions&query=%24.versions.0.num&colorB=orange&prefix=zfs-core-sys%20%3D%20%22&suffix=%22)](https://crates.io/crates/zfs-core-sys)
+
+[![zfs-core-sys docs.rs](https://img.shields.io/badge/documentation-release-brightgreen.svg?style=flat)](https://docs.rs/zfs-core-sys/)
+
+[![nvpair crates.io](https://img.shields.io/badge/dynamic/json.svg?label=crates.io&url=https%3A%2F%2Fcrates.io%2Fapi%2Fv1%2Fcrates%2Fnvpair%2Fversions&query=%24.versions.0.num&colorB=orange&prefix=nvpair%20%3D%20%22&suffix=%22)](https://crates.io/crates/nvpair)
+
+[![nvpair docs.rs](https://img.shields.io/badge/documentation-release-brightgreen.svg?style=flat)](https://docs.rs/nvpair/)
+
+[![nvpair-sys crates.io](https://img.shields.io/badge/dynamic/json.svg?label=crates.io&url=https%3A%2F%2Fcrates.io%2Fapi%2Fv1%2Fcrates%2Fnvpair-sys%2Fversions&query=%24.versions.0.num&colorB=orange&prefix=nvpair-sys%20%3D%20%22&suffix=%22)](https://crates.io/crates/nvpair-sys)
+
+[![nvpair-sys docs.rs](https://img.shields.io/badge/documentation-release-brightgreen.svg?style=flat)](https://docs.rs/nvpair-sys/)
+
+## License
+
+Licensed under either of
+ * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+ at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.