From be6ee0f8abc636cd9eb3c4220fecbcb01cf21530 Mon Sep 17 00:00:00 2001 From: Faruk Kasumovic Date: Mon, 20 Apr 2015 00:45:29 +0200 Subject: [PATCH] - Added list of main features to README, and small aperance improvements --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d83a88f..c4ca12b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,30 @@ # Introduction -Currently implements basic manipulation of ZFS pools and data sets. Plan is to add more in further development, improve documentation with more examples, and add more tests. _go-libzfs_ use libzfs C library and does not wrap OpenZFS CLI tools. That way it ensure best performance. Per my personal opinion its more reliable way to do it, and that libzfs is less subject of possible changes then CLI tools. Goal is to let easy using and manipulating OpenZFS form with in go, and tries to map libzfs C library in to go style package respecting golang common practice. +**go-libzfs** currently implements basic manipulation of ZFS pools and data sets. Plan is to add more in further development, improve documentation with more examples, and add more tests. _go-libzfs_ use libzfs C library and does not wrap OpenZFS CLI tools. That way it ensure best performance. Per my personal opinion its more reliable way to do it, and that libzfs is less subject of possible changes then CLI tools. Goal is to let easy using and manipulating OpenZFS form with in go, and tries to map libzfs C library in to go style package respecting golang common practice. [![GoDoc](https://godoc.org/github.com/fkasumovic/go-libzfs?status.svg)](https://godoc.org/github.com/fkasumovic/go-libzfs) -# Requirements: +## Main features + +- Creating, destroying, importing and exporting pools. +- Reading and modifying pool properties. +- Creating, destroying and renaming of filesystem datasets and volumes. +- Creating, destroying and rollback of snapshots. +- Cloning datasets and volumes. +- Reading and modifying dataset and volume properties. + +## Requirements: - OpenZFS and libzfs with development headers installed. - Developed using go1.4.2 -# Installing +## Installing ```sh go get github.com/fkasumovic/go-libzfs ``` -# Testing +## Testing ```sh # On command line shell run @@ -23,7 +32,7 @@ cd $GOPATH/src/github.com/fkasumovic/go-libzfs go test ``` -# Usage example +## Usage example ```go // Create map to represent ZFS dataset properties. This is equivalent to