make readme method return an io.Reader

workspace.go

@@ -4,7 +4,9 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"io"
 	"net/url"
+	"strings"
 	"time"
 )
 
@@ -124,11 +126,17 @@ type Workspace struct {
 
 // Readme will retrieve any readme file attached to the workspace. "" if none
 // exists.
-func (w *Workspace) Readme(ctx context.Context) (string, error) {
+func (w *Workspace) Readme(ctx context.Context) (io.Reader, error) {
 	if w.readme == nil {
-		return "", nil
+		return nil, nil
 	}
-	return w.readme(ctx)
+
+	readme, err := w.readme(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	return strings.NewReader(readme), nil
 }
 
 // VCSRepo contains the configuration of a VCS integration.