fix typos and docs

Nota30 · Feb 11, 2024 · c714722 · c714722
1 parent 59806fb
commit c714722
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ import (
 func main() {
 	gify := gifenc.Config{}
 
-    // Decode
+	// Decode
 	var gif *gif.GIF // Provide a gif
 	imgs, err := gify.Decode(gif)
 	if err != nil {

diff --git a/decode.go b/decode.go
@@ -7,6 +7,7 @@ import (
 	"image/gif"
 )
 
+// Decode a gif. This will split the GIF into multiple images.
 func (config Config) Decode(gif *gif.GIF) ([]*image.RGBA, error) {
 	imgs, err := split(gif, config.Width, config.Height)
 	if err != nil {

diff --git a/encode.go b/encode.go
@@ -7,6 +7,7 @@ import (
 	"image/gif"
 )
 
+// Encode a GIF. Provide an array of image to be combined into a GIF.
 func (config Config) Encode(images []image.Image) (*gif.GIF, error) {
 	animated := gif.GIF{
 		LoopCount: 0,