Prepare repository for release (#40)

README.md

@@ -1,7 +1,7 @@
 # Go-flow
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/Prastiwar/go-flow.svg)](https://pkg.go.dev/github.com/Prastiwar/Go-flow)
-[![Go Report Card](https://goreportcard.com/badge/github.com/oklahomer/go-sarah)](https://goreportcard.com/report/github.com/Prastiwar/Go-flow)
+[![Go Report Card](https://goreportcard.com/badge/github.com/Prastiwar/go-flow)](https://goreportcard.com/report/github.com/Prastiwar/Go-flow)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Prastiwar_Go-flow&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Prastiwar_Go-flow)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Prastiwar_Go-flow&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Prastiwar_Go-flow)
 

di/constructor.go

@@ -33,7 +33,7 @@ type Constructor interface {
 	// Dependencies returns an array of reflect.Type defining type of dependencies for object to construct.
 	Dependencies() []reflect.Type
 
-	// Life returns LifeTime which defines scope of existance for constructed object.
+	// Life returns LifeTime which defines scope of existence for constructed object.
 	Life() LifeTime
 }
 

httpf/rate.go

@@ -81,7 +81,7 @@ func ComposeRateKeyFactories(factories ...RateHttpKeyFactory) RateHttpKeyFactory
 
 // RateLimitMiddleware returns httpf.Handler which uses rate-limiting feature to decide if h Handler can be requested.
 // If rate limit exceeds maximum value, the error is returned and should be handled by ErrorHandler to actually
-// return 429 status code with appropiate body. This middleware writes all of
+// return 429 status code with appropriate body. This middleware writes all of
 // "X-Rate-Limit-Limit", "X-Rate-Limit-Remaining" and "X-Rate-Limit-Reset" headers with correct values.
 func RateLimitMiddleware(h Handler, store rate.LimiterStore, keyFactory RateHttpKeyFactory) Handler {
 	if store == nil {

rate/limiter.go

@@ -3,7 +3,7 @@
 // The package does contain example alghoritm most often used in Web API's but there are much more algorithms already implemented
 // in Go which are open-sourced by the Golang community. Use this package to abstract away the specific implementations
 // provided by third party libraries. This requires to write an adapter for implementation to fulfill rate interfaces
-// in your infrastracture layer.
+// in your infrastructure layer.
 package rate
 
 import "context"

rate/memory/store.go

@@ -15,7 +15,7 @@ var (
 )
 
 var (
-	ErrCleanupFailure   = errors.New("at least one error occured at cleanup")
+	ErrCleanupFailure   = errors.New("at least one error occurred at cleanup")
 	ErrMissingAlgorithm = errors.New("nil LimiterAlgorithm was passed to constructor")
 )
 

rate/wait.go

@@ -24,7 +24,7 @@ func Wait(ctx context.Context, deadline time.Time) error {
 	}
 }
 
-// ConsumeAndWait calls Take() on Limiter and immedietely Use the Token. If ErrRateLimitExceeded error occurs
+// ConsumeAndWait calls Take() on Limiter and immediately Use the Token. If ErrRateLimitExceeded error occurs
 // it pauses the current goroutine until Limiter's ResetsAt() time deadline exceeds. If Take() returns any
 // other error it'll immediately return this error. When ctx is canceled or ctx deadline exceeds before
 // reset time it'll return this error.

tests/assert/slices_test.go

@@ -24,7 +24,7 @@ func TestElementsMatch(t *testing.T) {
 			fails: false,
 		},
 		{
-			name: "not-matches-similiar",
+			name: "not-matches-similar",
 			arrA: []any{
 				1, 2, 3,
 			},