From f95774f32109db7817da41a93e43cd6eba9b3673 Mon Sep 17 00:00:00 2001
From: abad <sumit.kumar@digimantra.com>
Date: Fri, 27 Sep 2024 13:06:09 +0530
Subject: [PATCH] readme modified

---
 README.md          | 6 +++---
 index.js           | 6 ++----
 lib/rateLimiter.js | 1 -
 package.json       | 8 ++++----
 4 files changed, 9 insertions(+), 12 deletions(-)
 mode change 100644 => 100755 README.md

diff --git a/README.md b/README.md
old mode 100644
new mode 100755
index 2d91942..3573f7c
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@ A customizable rate-limiting and throttling middleware for Node.js applications.
 You can install the package via npm:
 
 ```bash
-npm install rate-limiter
+npm install rate-limitx
 ```
 
 ## Usage
@@ -25,7 +25,7 @@ The package can be used as middleware in your Node.js/Express applications to li
 
 ```javascript
 const express = require('express');
-const rateLimiter = require('rate-limiter');
+const rateLimiter = require('rate-limitx');
 
 const app = express();
 
@@ -112,6 +112,6 @@ If you encounter any problems or have any questions, feel free to open an issue
 ## Links
 
 - **GitHub**: [https://git.digimantra.com/abad_dml/rate-limiter](https://git.digimantra.com/abad_dml/rate-limiter)
-- **NPM**: [https://www.npmjs.com/package/rate-limiter-digimantra](https://www.npmjs.com/package/rate-limiter-digimantra)
+- **NPM**: [https://www.npmjs.com/package/rate-limitx](https://www.npmjs.com/package/rate-limitx)
 
 ---
diff --git a/index.js b/index.js
index f00d533..ee02e53 100755
--- a/index.js
+++ b/index.js
@@ -1,21 +1,19 @@
 const RateLimiter = require('./lib/rateLimiter');
 
-// Middleware wrapper for Express.js or any other Node.js framework
 const rateLimiterMiddleware = (options) => {
   const limiter = new RateLimiter(options);
 
   return (req, res, next) => {
-    const clientId = req.ip; // Use IP-based rate limiting
+    const clientId = req.ip;
     const result = limiter.handleRequest(clientId);
 
     if (!result.allowed) {
       return res.status(429).json({
         message: 'Too many requests. Please try again later.',
-        retryAfter: result.remainingTime / 1000, // Retry after (seconds)
+        retryAfter: result.remainingTime / 1000,
       });
     }
 
-    // If allowed, proceed to the next middleware or route handler
     next();
   };
 };
diff --git a/lib/rateLimiter.js b/lib/rateLimiter.js
index bf8aa2f..43c4ad5 100755
--- a/lib/rateLimiter.js
+++ b/lib/rateLimiter.js
@@ -8,7 +8,6 @@ class RateLimiter {
     this.clients = new Map();
   }
 
-  // Function to handle a request
   handleRequest(clientId) {
     const currentTime = Date.now();
 
diff --git a/package.json b/package.json
index 81708e5..93ea4c5 100755
--- a/package.json
+++ b/package.json
@@ -1,9 +1,9 @@
 {
-  "name": "rate-limiter-digimantra",
-  "version": "1.1.0",    
+  "name": "rate-limitx",
+  "version": "1.4.0",
   "description": "Custom rate limiting middleware for Node.js",
-  "main": "index.js",    
-  "keywords": [          
+  "main": "index.js",
+  "keywords": [
     "rate-limiting",
     "rate-limiter",
     "secure-api",