]> git.immae.eu Git - github/fretlink/terraform-provider-statuscake.git/blobdiff - vendor/github.com/ulikunitz/xz/README.md
Upgrade to 0.12
[github/fretlink/terraform-provider-statuscake.git] / vendor / github.com / ulikunitz / xz / README.md
index 969ae7a00b3cfbac3c39c5032dd2bf990e98029f..0a2dc8284f86dd05e2154d93be84473e3bad9d5a 100644 (file)
@@ -12,46 +12,48 @@ have been developed over a long time and are highly optimized. However
 there are a number of improvements planned and I'm very optimistic about
 parallel compression and decompression. Stay tuned!
 
-# Using the API
+## Using the API
 
 The following example program shows how to use the API.
 
-    package main
-
-    import (
-        "bytes"
-        "io"
-        "log"
-        "os"
-
-        "github.com/ulikunitz/xz"
-    )
-
-    func main() {
-        const text = "The quick brown fox jumps over the lazy dog.\n"
-        var buf bytes.Buffer
-        // compress text
-        w, err := xz.NewWriter(&buf)
-        if err != nil {
-            log.Fatalf("xz.NewWriter error %s", err)
-        }
-        if _, err := io.WriteString(w, text); err != nil {
-            log.Fatalf("WriteString error %s", err)
-        }
-        if err := w.Close(); err != nil {
-            log.Fatalf("w.Close error %s", err)
-        }
-        // decompress buffer and write output to stdout
-        r, err := xz.NewReader(&buf)
-        if err != nil {
-            log.Fatalf("NewReader error %s", err)
-        }
-        if _, err = io.Copy(os.Stdout, r); err != nil {
-            log.Fatalf("io.Copy error %s", err)
-        }
+```go
+package main
+
+import (
+    "bytes"
+    "io"
+    "log"
+    "os"
+
+    "github.com/ulikunitz/xz"
+)
+
+func main() {
+    const text = "The quick brown fox jumps over the lazy dog.\n"
+    var buf bytes.Buffer
+    // compress text
+    w, err := xz.NewWriter(&buf)
+    if err != nil {
+        log.Fatalf("xz.NewWriter error %s", err)
     }
+    if _, err := io.WriteString(w, text); err != nil {
+        log.Fatalf("WriteString error %s", err)
+    }
+    if err := w.Close(); err != nil {
+        log.Fatalf("w.Close error %s", err)
+    }
+    // decompress buffer and write output to stdout
+    r, err := xz.NewReader(&buf)
+    if err != nil {
+        log.Fatalf("NewReader error %s", err)
+    }
+    if _, err = io.Copy(os.Stdout, r); err != nil {
+        log.Fatalf("io.Copy error %s", err)
+    }
+}
+```
 
-# Using the gxz compression tool
+## Using the gxz compression tool
 
 The package includes a gxz command line utility for compression and
 decompression.