Rename to go-ignore

Renamed to go-ignore, emphasising that the parsed format is not
restricted to gitignore files, but potentially other (dockerignore)
formats too

The differences between .gitignore, .dockerignore are due to the
interpretation of the paths, which this package makes no effort to
handle

README.md

@@ -1,10 +1,18 @@
-# go-gitignore
+# go-ignore
 
-A simple gitignore format parser.
+A simple gitignore/dockerignore format parser.
 
-This package parses .gitignore files into a publicly exposed struct for usage in other
-packages. It does not provide any matching capabilities, nor does it support
-marshalling the gitignore Entries.
+This package parses .gitignore and .dockerignore files into a publicly exposed struct
+for usage in other packages. It does not provide any matching capabilities, nor does it support
+marshalling the Entries.
+
+## .gitignore vs .dockerignore
+
+There are functional differences between .gitignore and .dockerignore. This is manifest in
+how files/directories are matched, but that functionality is beyond the scope of this package.
+
+From a file structure perspective the two formats are deemed equivalent, in that both support
+paths, negated paths, comments, and whitespace lines.
 
 ## API
 
@@ -34,7 +42,7 @@ package main
 import (
         "fmt"
 
-        ignore "github.com/shteou/go-gitignore"
+        ignore "github.com/shteou/go-ignore"
 )
 
 func main() {

go.mod

@@ -1,4 +1,4 @@
-module github.com/shteou/go-gitignore
+module github.com/shteou/go-ignore
 
 go 1.13
 

ignore.go

@@ -40,7 +40,7 @@ func Unescape(s string) string {
 }
 
 // ParseIgnoreLines Parse the supplied lines into a Go representation of that those
-// gitignore entries
+// ignore entries
 func ParseIgnoreLines(lines []string) ([]Entry, error) {
 	ignoreEntries := []Entry{}
 
@@ -62,7 +62,7 @@ func ParseIgnoreLines(lines []string) ([]Entry, error) {
 }
 
 // ParseIgnoreBytes Parse the supplied byte array into a Go representation of those
-// gitignore entries
+// gnore entries
 func ParseIgnoreBytes(bytes []byte) ([]Entry, error) {
 	lines := strings.Split(string(bytes), "\n")
 	return ParseIgnoreLines(lines)