From a0d6686cbcb1ec6730b17973a53f93adef72db32 Mon Sep 17 00:00:00 2001
From: Spencer Brower <foxtrotalphalima@gmail.com>
Date: Sun, 24 Jun 2018 16:38:52 -0400
Subject: [PATCH] Further documentation updates.

---
 README.md        |  3 +--
 ps.go            |  3 ++-
 ps_test.go       |  6 +++---
 runner/README.md | 11 +++++++++++
 runner/runner.go |  6 ++++++
 5 files changed, 23 insertions(+), 6 deletions(-)
 create mode 100644 runner/README.md

diff --git a/README.md b/README.md
index f3f2dbd..afc4a43 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,7 @@
 Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. The
 interaction between the two is implemented using Javascript/VBScript.
 
-Currently only supports Photoshop CS5 Windows x86_64. go:generate godocdown
--output=README.md
+Currently only supports Photoshop CS5 Windows x86_64.
 
 ## Installation
 ```bash
diff --git a/ps.go b/ps.go
index aa1b604..559383d 100644
--- a/ps.go
+++ b/ps.go
@@ -1,8 +1,9 @@
+//go:generate godocdown -output=README.md
+
 // Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang.
 // The interaction between the two is implemented using Javascript/VBScript.
 //
 // Currently only supports Photoshop CS5 Windows x86_64.
-//go:generate godocdown -output=README.md
 package ps
 
 import (
diff --git a/ps_test.go b/ps_test.go
index 479d347..66a431b 100644
--- a/ps_test.go
+++ b/ps_test.go
@@ -54,7 +54,7 @@ func TestClose(t *testing.T) {
 	if testing.Short() {
 		t.Skip("Skipping \"TestClose\"")
 	}
-	err := Close(2)
+	err := Close(DoNotSaveChanges)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -65,7 +65,7 @@ func TestQuit(t *testing.T) {
 		t.Skip("Skipping \"TestQuit\"")
 	}
 	Init()
-	err := Quit(2)
+	err := Quit(DoNotSaveChanges)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -95,7 +95,7 @@ func TestRun(t *testing.T) {
 		t.Fatal(err)
 	}
 	if string(msg) != string(out) {
-		fail := fmt.Sprintf("TestRun faild.\ngot:\n\"%s\"\nwant:\n\"%s\"\n", msg, out)
+		fail := fmt.Sprintf("TestRun failed.\ngot:\n\"%s\"\nwant:\n\"%s\"\n", msg, out)
 		t.Fatal(fail)
 	}
 }
diff --git a/runner/README.md b/runner/README.md
new file mode 100644
index 0000000..db98fe5
--- /dev/null
+++ b/runner/README.md
@@ -0,0 +1,11 @@
+# runner
+[![GoDoc](https://godoc.org/github.com/sbrow/runner?status.svg)](https://godoc.org/github.com/sbrow/runner) [![Build Status](https://travis-ci.org/sbrow/runner.svg?branch=master)](https://travis-ci.org/sbrow/runner) [![Coverage Status](https://coveralls.io/repos/github/sbrow/runner/badge.svg?branch=master)](https://coveralls.io/github/sbrow/runner?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/sbrow/runner)](https://goreportcard.com/report/github.com/sbrow/runner)
+
+Package runner runs the non-go code that Photoshop understands, and passes it to
+back to the go program. Currently, this is primarily implemented through Adobe
+Extendscript, but hopefully in the future it will be upgraded to a C++ plugin.
+
+## Installation
+```bash
+$ go get -u github.com/sbrow/ps/runner
+```
diff --git a/runner/runner.go b/runner/runner.go
index 870497c..ac30e51 100644
--- a/runner/runner.go
+++ b/runner/runner.go
@@ -1,3 +1,9 @@
+//go:generate godocdown -template ../.godocdown.template -output=README.md
+
+// Package runner runs the non-go code that Photoshop understands,
+// and passes it to back to the go program. Currently, this is
+// primarily implemented through Adobe Extendscript, but hopefully
+// in the future it will be upgraded to a C++ plugin.
 package runner
 
 import (