README: format and notice

Fixes #3

Add a notice that these bindings are incomplete

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2017-05-17 10:12:39 -04:00
parent 1ab93081d9
commit d3db5c0037
Signed by: vbatts
GPG Key ID: 10937E57733F1362
1 changed files with 12 additions and 11 deletions

View File

@ -1,22 +1,23 @@
go-cgroup
=========
# go-cgroup
Bindings to the libcgroup library
## Notice
Installing
==========
_these bindings are incomplete_
go get github.com/vbatts/go-cgroup
## Installing
```shell
go get github.com/vbatts/go-cgroup
```
on debian, you'll need packages: golang, libcgroup-dev
on fedora, you'll need packages: golang, libcgroup-devel
Sample
======
## Sample
```
```golang
package main
import "github.com/vbatts/go-cgroup"
@ -39,7 +40,7 @@ func main() {
}
```
Contributing
============
## Contributing
Fork and Pull Request please!