Merge pull request #2 from SimonBaeumer/documetation

Improve documentation

Author: SimonBaeumer

README.md

@@ -15,7 +15,7 @@ A simple package to execute shell commands on linux, darwin and windows.
 ## Usage
 
 ```go
-cmd := NewCommand("echo hello")
+cmd := cmd.NewCommand("echo hello")
 
 err := cmd.Execute()
 if err != nil {
@@ -29,7 +29,7 @@ fmt.Println(cmd.Stderr())
 ### Stream output to stderr and stdout
 
 ```go
-cmd := NewCommand("echo hello", cmd.WithStandardStreams)
+cmd := cmd.NewCommand("echo hello", cmd.WithStandardStreams)
 cmd.Execute()
 ```
 
@@ -58,4 +58,4 @@ make test
 
 ### ToDo
 
- - os.Stdout and os.Stderr output access after execution
+ - os.Stdout and os.Stderr output access after execution via `c.Stdout()` and `c.Stderr()`

command.go

@@ -60,7 +60,14 @@ func NewCommand(cmd string, options ...func(*Command)) *Command {
 	return c
 }
 
-// WithStandardStreams creates a command which steams its output to the stderr and stdout streams of the operating system
+// WithStandardStreams is used as an option by the NewCommand constructor function and writes the output streams
+// to stderr and stdout of the operating system
+//
+// Example:
+//
+//      c := cmd.NewCommand("echo hello", cmd.WithStandardStreams)
+//      c.Execute()
+//
 func WithStandardStreams(c *Command) {
 	c.StdoutWriter = os.Stdout
 	c.StderrWriter = os.Stderr
@@ -77,7 +84,7 @@ func (c *Command) AddEnv(key string, value string) {
 	c.Env = append(c.Env, fmt.Sprintf("%s=%s", key, value))
 }
 
-// Removes the ${...} characters
+// Removes the ${...} characters at the beginng and end of the given string
 func removeEnvVarSyntax(v string) string {
 	return v[2:(len(v) - 1)]
 }