readme updated
This commit is contained in:
parent
5c6d981254
commit
11b007bc2a
11
README.md
11
README.md
|
@ -1,7 +1,3 @@
|
||||||
Here's the modified README with the code snippets updated to use **ES6** syntax (`import` instead of `require`):
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Rate Limiter
|
# Rate Limiter
|
||||||
|
|
||||||
A customizable rate-limiting and throttling middleware for Node.js applications. It allows you to limit the number of requests a client can make to your server within a specified time window.
|
A customizable rate-limiting and throttling middleware for Node.js applications. It allows you to limit the number of requests a client can make to your server within a specified time window.
|
||||||
|
@ -18,7 +14,7 @@ A customizable rate-limiting and throttling middleware for Node.js applications.
|
||||||
You can install the package via npm:
|
You can install the package via npm:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install rate-limitx
|
npm install digi-rate-limiter
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -29,7 +25,7 @@ The package can be used as middleware in your Node.js/Express applications to li
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
import express from 'express';
|
import express from 'express';
|
||||||
import rateLimiter from 'rate-limitx';
|
import rateLimiter from 'digi-rate-limiter';
|
||||||
|
|
||||||
const app = express();
|
const app = express();
|
||||||
|
|
||||||
|
@ -116,6 +112,7 @@ If you encounter any problems or have any questions, feel free to open an issue
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- **GitHub**: [https://git.digimantra.com/abad_dml/rate-limiter](https://git.digimantra.com/abad_dml/rate-limiter)
|
- **GitHub**: [https://git.digimantra.com/abad_dml/rate-limiter](https://git.digimantra.com/abad_dml/rate-limiter)
|
||||||
- **NPM**: [https://www.npmjs.com/package/rate-limitx](https://www.npmjs.com/package/rate-limitx)
|
- **NPM**: [https://www.npmjs.com/package/digi-rate-limiter](https://www.npmjs.com/package/digi-rate-limiter)
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "rate-limitx",
|
"name": "digi-rate-limiter",
|
||||||
"version": "1.4.0",
|
"version": "1.1.0",
|
||||||
"description": "Custom rate limiting middleware for Node.js",
|
"description": "Custom rate limiting middleware for Node.js",
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
|
Loading…
Reference in a new issue