Adding WebP & AVIF support, as well as a crude command-line tool

.editorconfig

@@ -0,0 +1,23 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+charset = utf-8
+indent_style = tab
+indent_size = tab
+tab_width = 4
+trim_trailing_whitespace = true
+
+# The property below is not yet universally supported
+[*.md]
+max_line_length = 108
+word_wrap = true
+# Markdown sometimes uses two spaces at the end to
+#  mark soft line breaks
+trim_trailing_whitespace = false
+
+[*.css]
+indent_style = space
+indent_size = 2

.gitignore

@@ -1,3 +1,57 @@
+~*
+# Stupid macOS temporary files
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+Icon?
+
+# Thumbnails
+._*
+nohup.out
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Stuff from the Nova editor
+.nova
+node_modules
+package.json
+package-lock.json
+.eslintrc.yml
+.prettierrc.json
+.env
+
+# logs
+*.log
+profile.out
+coverage.html
+coverage.txt
+delay.txt
+
+
+# executables
+tinify-go
+
 # Created by .ignore support plugin (hsz.mobi)
 ### Go template
 # Binaries for programs and plugins
@@ -11,9 +65,7 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+testdata/output/*
 
-# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
-.glide/
-.idea/
-test_output/*.jpg
-temp
+# Temporary debugger files
+__*

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,40 +1,54 @@
+![Tinify API client for Golang logo](testdata/assets/tinify-go-logo-pangopher-128x128.png)
+
 # Tinify API client for Golang
 
 [:book: 国内的朋友看这里](http://www.jianshu.com/p/5c4161db4ac8)
 
-------
+---
+
+Golang client for the [Tinify API](https://tinypng.com/developers/reference), used for [TinyPNG](https://tinypng.com) and [TinyJPG](https://tinyjpg.com). Tinify compresses or resizes your images intelligently. Read more at [http://tinify.com](http://tinify.com).
 
-Golang client for the Tinify API, used for [TinyPNG](https://tinypng.com) and [TinyJPG](https://tinyjpg.com). Tinify compresses or resize your images intelligently. Read more at [http://tinify.com](http://tinify.com).
+The code on this repository is the work of volunteers who are neither affiliated with, nor endorsed by Tinify B.V., the makers of the Tinify API and of TinyPNG.
 
 ## Documentation
 
 [Go to the documentation for the HTTP client](https://tinypng.com/developers/reference).
 
 ## Installation
 
-Install the API client with `go get`.
+Install the API client with `go install`.
 
 ```shell
-go get -u github.com/gwpp/tinify-go
+go install github.com/gwpp/tinify-go
 ```
 
+Note that this repository will install two different things:
+
+1. A port of the Tinify API to the Go programming language, which will be placed under its own directory `./tinify`, a stand-alone package/module named `Tinify`;
+2. A client application, at the root of the repository, which will compile to an executable binary, using the `Tinify` package as an imported module.
+
+The client application serves both as a testing tool and as a stand-alone binary. It is very loosely based on other, similar client applications [written for other programming languages](https://github.com/tinify/).
+
+Remember, to use it, you need a valid Tinify API Key, passed wither with the `--key=XXXX` flag, or via the environment variable `TINIFY_API_KEY`.
+
 ## Usage
 
-- About key
+- About the TinyPNG API key
 
-    Get your API key from  https://tinypng.com/developers
+    Get your API key from https://tinypng.com/developers
 
 - Compress
+
     ```golang
     func TestCompressFromFile(t *testing.T) {
         Tinify.SetKey(Key)
-        source, err := Tinify.FromFile("./test.jpg")
+        source, err := Tinify.FromFile("./testdata/input/test.jpg")
         if err != nil {
             t.Error(err)
             return
         }
 
-        err = source.ToFile("./test_output/CompressFromFile.jpg")
+        err = source.ToFile("./testdata/output/CompressFromFile.jpg")
         if err != nil {
             t.Error(err)
             return
@@ -44,11 +58,12 @@ go get -u github.com/gwpp/tinify-go
     ```
 
 - Resize
+
     ```golang
     func TestResizeFromBuffer(t *testing.T) {
         Tinify.SetKey(Key)
 
-        buf, err := ioutil.ReadFile("./test.jpg")
+        buf, err := ioutil.ReadFile("./testdata/input/test.jpg")
         if err != nil {
             t.Error(err)
             return
@@ -68,7 +83,7 @@ go get -u github.com/gwpp/tinify-go
             return
         }
 
-        err = source.ToFile("./test_output/ResizesFromBuffer.jpg")
+        err = source.ToFile("./testdata/output/ResizesFromBuffer.jpg")
         if err != nil {
             t.Error(err)
             return
@@ -77,12 +92,11 @@ go get -u github.com/gwpp/tinify-go
     }
     ```
 
-- ***Notice:***
-
-    Tinify.ResizeMethod support `scale`, `fit` and `cover`. If used fit or cover, you must provide `both a width and a height`. But used scale, you must provide either a target width or a target height, `but not both`.
+- **_Notice:_**
 
+    `Tinify.ResizeMethod()` supports `scale`, `fit` and `cover`. If you use either fit or cover, you must provide **both a width and a height**. But if you use scale, you must instead provide _either_ a target width _or_ a target height, **but not both**.
 
-- More usage, please see [tinify_test.go](./tinify_test.go)
+- For further usage, please read the comments in [tinify_test.go](./tinify_test.go)
 
 ## Running tests
 
@@ -91,6 +105,20 @@ cd $GOPATH/src/github.com/gwpp/tinify-go
 go test
 ```
 
+## Command-line utility
+
+To build it:
+
+```shell
+cd $GOPATH/src/github.com/gwpp/tinify-go
+go build -ldflags "-X main.TheBuilder=$USER"
+# or, if you prefer, `go install`
+```
+
+and then invoke `./tinify-go --help` to get some basic instructions for the CLI.
+
 ## License
 
-This software is licensed under the MIT License. [View the license](LICENSE).
+This software is licensed under the [MIT License](LICENSE).
+
+The logo (a cross-breed between the gopher mascot and the TinyPNG panda!) was provided courtesy of Microsoft's image generative AI, which is currently based on OpenAI's DALL-E technology.

aux_test.go

@@ -0,0 +1,58 @@
+// Test suite for auxiiary functions.
+// The main testing, done by gwpp, is under tinify_test.go
+package main
+
+import (
+	"testing"
+)
+
+var tests = []struct {
+	hex   string
+	check bool
+}{
+	{"#000000", true},
+	{"00FF", true},
+	{"0#0", false},
+	{"", false},
+	{"#", false},
+	{"#F", false},
+	{"B", false},
+	{"abcdef01", true},
+	{"#abcdef01", true},
+	{"#abcdef0", false},
+	{"#abcdefg0", false},
+	{"#0f0", false},
+	{"0x0F", false},
+	{"10000", false},
+}
+
+// Given a series of what we consider to be valid colours in hexadecimal, test if
+// we got the expected results.
+func TestIsValidHex(t *testing.T) {
+	for _, tc := range tests {
+		if isValidHex(tc.hex) != tc.check {
+			t.Fatalf("checked %q if it was valid hex or not and expected %t", tc.hex, tc.check)
+		}
+	}
+}
+
+func BenchmarkIsValidHex(b *testing.B) {
+	for b.Loop() {
+		for _, tc := range tests {
+			if isValidHex(tc.hex) != tc.check {
+				b.Fatalf("checked %q if it was valid hex or not and expected %t", tc.hex, tc.check)
+			}
+		}
+	}
+}
+
+/*
+func BenchmarkIsValidHexChatGPT(b *testing.B) {
+	for b.Loop() {
+		for _, tc := range tests {
+			if isValidHexChatGPT(tc.hex) != tc.check {
+				b.Fatalf("checked %q if it was valid hex or not and expected %t", tc.hex, tc.check)
+			}
+		}
+	}
+} */