- Added list of main features to README, and small aperance improvements
Make LICENSE more easy to read on GitHub
This commit is contained in:
parent
cf7673fe41
commit
e67132bb04
|
@ -0,0 +1 @@
|
||||||
|
.gitconfig
|
26
LICENSE
26
LICENSE
|
@ -1,12 +1,28 @@
|
||||||
Copyright (c) 2015, Faruk Kasumovic
|
Copyright (c) 2015, Faruk Kasumovic
|
||||||
All rights reserved.
|
All rights reserved.
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
1. Redistributions of source code must retain the above copyright notice, this
|
||||||
|
list of conditions and the following disclaimer.
|
||||||
|
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
3. Neither the name of the copyright holder nor the names of its contributors
|
||||||
|
may be used to endorse or promote products derived from this software without
|
||||||
|
specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||||
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||||
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||||
|
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||||
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||||
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||||
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||||
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||||
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
|
|
19
README.md
19
README.md
|
@ -1,21 +1,30 @@
|
||||||
# Introduction
|
# 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)
|
[![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.
|
- OpenZFS and libzfs with development headers installed.
|
||||||
- Developed using go1.4.2
|
- Developed using go1.4.2
|
||||||
|
|
||||||
# Installing
|
## Installing
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
go get github.com/fkasumovic/go-libzfs
|
go get github.com/fkasumovic/go-libzfs
|
||||||
```
|
```
|
||||||
|
|
||||||
# Testing
|
## Testing
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# On command line shell run
|
# On command line shell run
|
||||||
|
@ -23,7 +32,7 @@ cd $GOPATH/src/github.com/fkasumovic/go-libzfs
|
||||||
go test
|
go test
|
||||||
```
|
```
|
||||||
|
|
||||||
# Usage example
|
## Usage example
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// Create map to represent ZFS dataset properties. This is equivalent to
|
// Create map to represent ZFS dataset properties. This is equivalent to
|
||||||
|
|
Loading…
Reference in New Issue