Support README in playbooks (#471)

Signed-off-by: David Chung <[email protected]>

Author: David Chung

pkg/cli/remote/remote.go

@@ -3,6 +3,7 @@ package remote
 import (
 	"fmt"
 	"io"
+	"path"
 	"strings"
 
 	"github.com/docker/infrakit/pkg/cli"
@@ -16,6 +17,13 @@ import (
 
 var log = logutil.New("module", "cli/remote")
 
+// helpTemplate is for embedding content from README.md in the same directory.
+const helpTemplate = `{{with or .Long .Short }}{{. | trim}}
+
+%s
+{{end}}{{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}
+`
+
 type remote struct {
 	modules Modules
 	input   io.Reader
@@ -104,6 +112,15 @@ loop:
 		// if we can parse it as a map, then we have a 'directory'
 		mods, err := dir(url)
 		if err == nil {
+
+			// Documentation -- look for a README.md at the given dir
+			readme := path.Join(path.Dir(string(url)), "README.md")
+			if t, err := template.NewTemplate(readme, template.Options{}); err == nil {
+				if view, err := t.Render(nil); err == nil {
+					cmd.SetHelpTemplate(fmt.Sprintf(helpTemplate, view))
+				}
+			}
+
 			copy := url
 			subs, err := list(plugins, mods, input, cmd, &copy)
 			if err != nil {

pkg/rpc/mux/reverse_proxy_test.go

@@ -143,11 +143,11 @@ func TestMuxPlugins(t *testing.T) {
 	})
 	require.NotNil(t, rp)
 
-	proxy, err := startProxy(t, ":8080", rp)
+	proxy, err := startProxy(t, ":24864", rp)
 	require.NoError(t, err)
 	defer proxy.Stop(10 * time.Second)
 
-	get := "http://localhost:8080/" + pluginName + rpc.URLAPI
+	get := "http://localhost:24864/" + pluginName + rpc.URLAPI
 
 	T(100).Infoln("Basic info client:", get)
 	resp, err := http.Get(get)