Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Added a purpose section
  • Loading branch information
adevinwild authored Jun 26, 2024
1 parent 8bff678 commit 915eeed
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@
A simple rate-limit plugin for Medusa.
</p>

<h2>
Purpose
</h2>

<p>This plugin was mainly built to protect your MedusaJS application from abuse. This plugin allows you to easily manage request limits without stepping outside the familiar Medusa environment.</p>

<h3>Why Rate Limiting Matters</h3>

<ol>
<li><strong>Shield Against Attacks</strong>: Prevent Denial of Service (DoS) attempts by capping the number of requests from a single source.</li>
<li><strong>Boost Security</strong>: Thwart brute force attacks and other automated threats by controlling request frequency.</li>
<li><strong>Easy Setup</strong>: Seamlessly integrate rate limiting into your existing Medusa configuration files.</li>
</ol>

<h2>
Installation
</h2>
Expand Down

0 comments on commit 915eeed

Please sign in to comment.