change module name

README.md

@@ -2,17 +2,17 @@
 <img src="https://discord.com/api/guilds/844418702430175272/embed.png">
 </a>
 
-# GinRateLimit
+# gin-rate-limit
 
-GinRateLimit is a rate limiter for the <a href="https://github.com/gin-gonic/gin">gin framework</a>. By default, it can
+gin-rate-limit is a rate limiter for the <a href="https://github.com/gin-gonic/gin">gin framework</a>. By default, it can
 only store rate limit info in memory and with redis. If you want to store it somewhere else you can make your own store
 or use third party stores. The library is new so there are no third party stores yet, so I would appreciate if someone
 could make one.
 
 Install
 
  ```shell
- go get github.com/JGLTechnologies/GinRateLimit
+ go get github.com/JGLTechnologies/gin-rate-limit
 ```
 
 <br>
@@ -23,7 +23,7 @@ Redis Example
 package main
 
 import (
-	"github.com/JGLTechnologies/GinRateLimit"
+	"github.com/JGLTechnologies/gin-rate-limit"
 	"github.com/gin-gonic/gin"
 	"github.com/go-redis/redis/v8"
 	"time"
@@ -40,10 +40,10 @@ func errorHandler(c *gin.Context, remaining time.Duration) {
 func main() {
 	server := gin.Default()
 	// This makes it so each ip can only make 5 requests per second
-	store := GinRateLimit.RedisStore(time.Second, 5, redis.NewClient(&redis.Options{
+	store := ratelimit.RedisStore(time.Second, 5, redis.NewClient(&redis.Options{
 		Addr: "localhost:7680",
 	}), false)
-	mw := GinRateLimit.RateLimiter(keyFunc, errorHandler, store)
+	mw := ratelimit.RateLimiter(keyFunc, errorHandler, store)
 	server.GET("/", mw, func(c *gin.Context) {
 		c.String(200, "Hello World")
 	})
@@ -60,7 +60,7 @@ package main
 
 import (
 	"github.com/gin-gonic/gin"
-	"github.com/JGLTechnologies/GinRateLimit"
+	"github.com/JGLTechnologies/gin-rate-limit"
 	"time"
 )
 
@@ -75,8 +75,8 @@ func errorHandler(c *gin.Context, remaining time.Duration) {
 func main() {
 	server := gin.Default()
 	// This makes it so each ip can only make 5 requests per second
-	store := GinRateLimit.InMemoryStore(time.Second, 5)
-	mw := GinRateLimit.RateLimiter(keyFunc, errorHandler, store)
+	store := ratelimit.InMemoryStore(time.Second, 5)
+	mw := ratelimit.RateLimiter(keyFunc, errorHandler, store)
 	server.GET("/", mw, func(c *gin.Context) {
 		c.String(200, "Hello World")
 	})

go.mod

@@ -1,4 +1,4 @@
-module github.com/JGLTechnologies/GinRateLimit
+module github.com/JGLTechnologies/gin-rate-limit
 
 go 1.18
 

GinRateLimit.go → in_memory.go

@@ -1,4 +1,4 @@
-package GinRateLimit
+package ratelimit
 
 import (
 	"github.com/gin-gonic/gin"

redis.go

@@ -1,4 +1,4 @@
-package GinRateLimit
+package ratelimit
 
 import (
 	"context"