Update README.md

README.md

@@ -1,14 +1,54 @@
 # copy
 
 [![Actions Status](https://github.com/otiai10/copy/workflows/Go/badge.svg)](https://github.com/otiai10/copy/actions)
-[![codecov](https://codecov.io/gh/otiai10/copy/branch/master/graph/badge.svg)](https://codecov.io/gh/otiai10/copy)
+[![codecov](https://codecov.io/gh/otiai10/copy/branch/main/graph/badge.svg)](https://codecov.io/gh/otiai10/copy)
 [![GoDoc](https://godoc.org/github.com/otiai10/copy?status.svg)](https://godoc.org/github.com/otiai10/copy)
 [![Go Report Card](https://goreportcard.com/badge/github.com/otiai10/copy)](https://goreportcard.com/report/github.com/otiai10/copy)
 
 `copy` copies directories recursively.
 
-Example:
+# Example Usage
 
 ```go
 err := Copy("your/directory", "your/directory.copy")
 ```
+
+# Advanced Usage
+
+```go
+// Options specifies optional actions on copying.
+type Options struct {
+
+	// OnSymlink can specify what to do on symlink
+	OnSymlink func(src string) SymlinkAction
+
+	// OnDirExists can specify what to do when there is a directory already existing in destination.
+	OnDirExists func(src, dest string) DirExistsAction
+
+	// Skip can specify which files should be skipped
+	Skip func(src string) (bool, error)
+
+	// AddPermission to every entities,
+	// NO MORE THAN 0777
+	AddPermission os.FileMode
+
+	// Sync file after copy.
+	// Useful in case when file must be on the disk
+	// (in case crash happens, for example),
+	// at the expense of some performance penalty
+	Sync bool
+
+	// Preserve the atime and the mtime of the entries
+	// On linux we can preserve only up to 1 millisecond accuracy
+	PreserveTimes bool
+
+}
+```
+
+```go
+err := Copy("your/directory", "your/directory.copy", opt)
+```
+
+# Issues
+
+- https://github.com/otiai10/copy/issues

options.go

@@ -4,20 +4,26 @@ import "os"
 
 // Options specifies optional actions on copying.
 type Options struct {
+
 	// OnSymlink can specify what to do on symlink
 	OnSymlink func(src string) SymlinkAction
-	// OnDirExists can specify what to do when there is a directory already exists in destination.
+
+	// OnDirExists can specify what to do when there is a directory already existing in destination.
 	OnDirExists func(src, dest string) DirExistsAction
+
 	// Skip can specify which files should be skipped
 	Skip func(src string) (bool, error)
+
 	// AddPermission to every entities,
 	// NO MORE THAN 0777
 	AddPermission os.FileMode
+
 	// Sync file after copy.
 	// Useful in case when file must be on the disk
 	// (in case crash happens, for example),
 	// at the expense of some performance penalty
 	Sync bool
+
 	// Preserve the atime and the mtime of the entries
 	// On linux we can preserve only up to 1 millisecond accuracy
 	PreserveTimes bool