quick: add an example (#70)

Fixes #69.
alecthomas · Oct 22, 2017 · 8533b63 · 8533b63
1 parent 972d700
commit 8533b63
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/quick/example_test.go b/quick/example_test.go
@@ -0,0 +1,19 @@
+package quick_test
+
+import (
+	"log"
+	"os"
+
+	"github.com/alecthomas/chroma/quick"
+)
+
+func Example() {
+	code := `package main
+
+func main() { }
+`
+	err := quick.Highlight(os.Stdout, code, "go", "html", "monokai")
+	if err != nil {
+		log.Fatal(err)
+	}
+}
diff --git a/quick/quick.go b/quick/quick.go
@@ -1,3 +1,4 @@
+// Package quick provides simple, no-configuration source code highlighting.
 package quick
 
 import (