Updating go.mod and documentation with the new API

Author: esimov

README.md

@@ -16,18 +16,8 @@ Radius       | Javascript  | Go
 
 ## Installation
 
-First, install Go, set your GOPATH, and make sure $GOPATH/bin is on your PATH.
-
-```bash
-$ export GOPATH="$HOME/go"
-$ export PATH="$PATH:$GOPATH/bin"
-```
-
-Next download the project and build the binary file.
-
 ```bash
-$ go get -u -f github.com/esimov/stackblur-go
-$ cd cmd && go build -o $GOPATH/bin/stackblur
+$ go install github.com/esimov/stackblur-go/cmd/stackblur@latest
 ```
 
 #### CLI example
@@ -55,10 +45,10 @@ The cli command supports a `-gif` flag, which if set as true it visualize the bl
 
 ## API
 
-The usage of the API is very simple: you need to expose an image file and a blur radius to the `Process` function. This will return the blurred version of the original image.
+The usage of the API is very simple: it exposes a single public `Process` function which requires a destination and a source image together with a blur radius. The blured image will be encoded into the destination image.
 
 ```Go
-stackblur.Process(src, blurRadius)
+stackblur.Process(dst, src, blurRadius)
 ```
 
 ## Results

cmd/main.go cmd/stackblur/main.gocmd/main.go renamed to cmd/stackblur/main.go

@@ -60,13 +60,13 @@ func main() {
 
 		for i := 0; i < *radius; i++ {
 			go func(idx int) {
-				img := image.NewNRGBA(src.Bounds())
-				err := stackblur.Run(img, src, uint32(idx+1))
+				dst := image.NewNRGBA(src.Bounds())
+				err := stackblur.Process(dst, src, uint32(idx+1))
 				if err != nil {
 					log.Fatal(err)
 				}
 				fmt.Printf("frame %d/%d\n", idx, *radius)
-				imgs[idx] = img
+				imgs[idx] = dst
 
 				wg.Done()
 			}(i)
@@ -82,12 +82,12 @@ func main() {
 			log.Fatal(err)
 		}
 	} else {
-		img := image.NewNRGBA(src.Bounds())
-		err := stackblur.Run(img, src, uint32(*radius))
+		dst := image.NewNRGBA(src.Bounds())
+		err := stackblur.Process(dst, src, uint32(*radius))
 		if err != nil {
 			log.Fatal(err)
 		}
-		if err := generateImage(*destination, img); err != nil {
+		if err := generateImage(*destination, dst); err != nil {
 			log.Fatalf("error generating the blurred image: %v", err)
 		}
 	}

doc.go

@@ -3,9 +3,9 @@ stackblur-go is a Go port of the Stackblur algorithm.
 
 Stackblur is a compromise between Gaussian blur and Box blur, but it creates much better looking blurs than Box blur and it is ~7x faster than Gaussian blur.
 
-The API is very simple and easy to integrate into any project. You only need to invoke the Process function which receive an image and a radius as parameters and returns the blurred version of the provided image.
+The usage of the API is very simple: it exposes a single public `Process` function which requires a destination and a source image together with a blur radius. The blured image will be encoded into the destination image.
 
-	func Process(src image.Image, radius uint32) (*image.NRGBA, error)
+	func Process(dst, src image.Image, radius uint32) error
 
 Below is a very simple example of how you can use this package.
 
@@ -28,12 +28,13 @@ Below is a very simple example of how you can use this package.
 		}
 		defer f.Close()
 
-		img, _, err := image.Decode(f)
+		src, _, err := image.Decode(f)
 		if err != nil {
 			log.Fatalf("could not decode source file: %v", err)
 		}
 
-		src, err := stackblur.Process(img, radius)
+		dst := image.NewNRGBA(src.Bounds())
+		err = stackblur.Process(dst, src, radius)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -44,7 +45,7 @@ Below is a very simple example of how you can use this package.
 		}
 		defer output.Close()
 
-		if err = jpeg.Encode(output, src, &jpeg.Options{Quality: 100}); err != nil {
+		if err = jpeg.Encode(output, dst, &jpeg.Options{Quality: 100}); err != nil {
 			log.Fatalf("could not encode destination image: %v", err)
 		}
 	}

go.mod

@@ -1,12 +1,8 @@
 module github.com/esimov/stackblur-go
 
-go 1.16
+go 1.24
 
-// Provides an unstable API
-retract v1.0.0
-
-// Introduces backwards incompatible changes
-retract v1.0.1
-
-// Also makes a backwards incompatible change
-retract v1.0.2
+// Unstable API
+retract (
+	[v1.0.0, v1.0.2]
+)

stackblur.go

@@ -53,8 +53,8 @@ var shgTable = []uint32{
 	24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24, 24,
 }
 
-// Run takes the source image and returns it's blurred version by applying the blur radius defined as parameter.
-func Run(dst, src image.Image, radius uint32) error {
+// Process takes the source image and returns it's blurred version by applying the blur radius defined as parameter.
+func Process(dst, src image.Image, radius uint32) error {
 	// Limit the maximum blur radius to 255 to avoid overflowing the multable.
 	if int(radius) >= len(mulTable) {
 		radius = uint32(len(mulTable) - 1)