Skip to content

Commit

Permalink
docs: compatibility list
Browse files Browse the repository at this point in the history
  • Loading branch information
rayriffy committed Mar 18, 2024
1 parent 693125a commit 55e5d26
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .changeset/giant-trainers-promise.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'elysia-rate-limit': major
---

Adapt plugin to 1.0
**Breaking change** Plugin compatibility with [Elysia 1.0](elysiajs.com/blog/elysia-10.html). Please refer to compatibility list in README for older Elysia, Bun versions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ bun add elysia-rate-limit

If you're using Bun v1.0.3 or lower, `elysia-rate-limit` v2.0.0 or higher will not be compatible. Please use `elysia-rate-limit` [v1.3.0](https://github.com/rayriffy/elysia-rate-limit/releases/tag/v1.3.0) instead.

## Compatibility

As long as you're on latest version of Bun, and Elysia. Using latest version of `elysia-rate-limit` would works just fine. However, please refer to following table to determine which version to use.

| Plugin version | Requirements |
| - | - |
| 3.0.0+ | Bun > 1.0.3, Elysia >= 1.0.0 |
| 2.0.0 - 2.2.0 | Bun > 1.0.3, Elysia < 1.0.0 |
| 1.0.2 - 1.3.0 | Bun <= 1.0.3, Elysia < 1.0.0 |

## Usage

Check out full sample at [`example`](example/index.ts)
Expand Down

0 comments on commit 55e5d26

Please sign in to comment.