Add description to DialInteractive

gorcon · Oct 5, 2020 · edc2a0c · edc2a0c
1 parent ba1c104
commit edc2a0c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -64,7 +64,8 @@ import (
 )
 
 func main() {
-	if err := telnet.DialInteractive(os.Stdin, os.Stdout, "172.19.0.2:8081", "banana"); err != nil {
+	err := telnet.DialInteractive(os.Stdin, os.Stdout, "172.19.0.2:8081", "")
+	if err != nil {
 		log.Println(err)
 	}
 }

diff --git a/telnet.go b/telnet.go
@@ -97,7 +97,8 @@ func Dial(address string, password string, options ...Option) (*Conn, error) {
 }
 
 // DialInteractive parses commands from input reader, executes them on remote
-// server and writes responses to output writer.
+// server and writes responses to output writer. Password can be empty string.
+// In this case password will be prompted in an interactive window.
 func DialInteractive(r io.Reader, w io.Writer, address string, password string, options ...Option) error {
 	settings := DefaultSettings