updated readme

wobito · Apr 7, 2017 · fc9adea · fc9adea
1 parent 467ac40
commit fc9adea
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,24 @@
 # go-losetup
 A losetup implementation for go-lang
+
+## how to get it
+```
+go get gopkg.in/freddierice/go-losetup.v1
+```
+
+## example usage
+```go
+// attach a raw file to a loop device
+dev, err := losetup.Attach("rawfile.img", 0, false)
+if err != nil {
+	// error checking
+}
+
+fmt.Printf("attached rawfile.img to %v\n", dev.Path())
+
+err := dev.Detach()
+if err != nil {
+	// error checking
+}
+```
+