Merge pull request #15 from petemoore/master

Update docs to reflect recent API changes
mholt · Oct 13, 2016 · 4a8a092 · 4a8a092
2 parents 9f68c7c + 7151643
commit 4a8a092
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -56,16 +56,16 @@ import "github.com/mholt/archiver"
 Create a .zip file:
 
 ```go
-err := archiver.Zip("output.zip", []string{"file.txt", "folder"})
+err := archiver.Zip.Make("output.zip", []string{"file.txt", "folder"})
 ```
 
 Extract a .zip file:
 
 ```go
-err := archiver.Unzip("input.zip", "output_folder")
+err := archiver.Zip.Open("input.zip", "output_folder")
 ```
 
-Working with other file formats is exactly the same, but with [their own functions](https://godoc.org/github.com/mholt/archiver).
+Working with other file formats is exactly the same, but with [their own Archiver implementations](https://godoc.org/github.com/mholt/archiver#Archiver).
 
 
 

diff --git a/zip.go b/zip.go
@@ -116,7 +116,7 @@ func zipFile(w *zip.Writer, source string) error {
 	})
 }
 
-// Unzip unzips the .zip file at source into destination.
+// Open unzips the .zip file at source into destination.
 func (zipFormat) Open(source, destination string) error {
 	r, err := zip.OpenReader(source)
 	if err != nil {