doc changes

bifrost/bifrost.go

@@ -17,7 +17,6 @@
 // Heimdall is designed as both launcher and monitor of short-lived CLI tools and programs. Heimdall provides the ability
 // to automatically repeat a process, kill a hung process started with the tool, and log the programs output (filtering logs
 // is also possible). It is hoped that heimdall and bifrost will be a tool you reach for again and again when developing your CLI tool.
-
 package bifrost
 
 import (
@@ -28,6 +27,7 @@ import (
 	"time"
 )
 
+// ManagerConfig manages configuration for the bifrost execution function
 type ManagerConfig struct {
 	AbsolutePath     string
 	ProgramArguments []string

main.go

@@ -12,12 +12,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package heimdall encompasses all functions related to the short-lived process manager by the same name. Heimdall
+// Command heimdall encompasses all functions related to the short-lived process manager by the same name. Heimdall
 // was the ever-vigilant guardian of the gods' stronghold, Asgard - now he will be the guardian of whichever program you choose.
 // Heimdall is designed as both launcher and monitor of short-lived CLI tools and programs. Heimdall provides the ability
 // to automatically repeat a process, kill a hung process started with the tool, and log the programs output (filtering logs
 // is also possible). It is hoped that heimdall and bifrost will be a tool you reach for again and again when developing your CLI tool.
-
 package main
 
 import "github.com/dnoberon/heimdall/cmd"

readme.md

@@ -1,3 +1,8 @@
+ Heimdall
+----
+[![GoDoc](https://godoc.org/github.com/DnOberon/heimdall/bifrost?status.svg)](https://godoc.org/github.com/DnOberon/heimdall/bifrost)
+
+
 #### Installation
 
 If you have the Go toolchain installed you can simply run