Skip to content
This repository was archived by the owner on Jun 25, 2025. It is now read-only.

Commit 147bd56

Browse files
committed
Update README to emphasize deprecation and migration to kemal-session
1 parent 20ce0dc commit 147bd56

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,38 @@
11
# kemal-csrf
22

3+
> **⚠️ DEPRECATED: This project has been moved to [kemal-session](https://github.com/kemalcr/kemal-session) and is no longer maintained as a separate package. Please use kemal-session for CSRF protection.**
4+
35
Adds CSRF protection to your [Kemal](http://kemalcr.com) application.
46

57
Requires a session middleware to be initialized first.
68

79
## Installation
810

11+
> **Note: This package is deprecated. Please use [kemal-session](https://github.com/kemalcr/kemal-session) instead, which now includes CSRF protection functionality.**
912
10-
Add this to your application's `shard.yml`:
13+
For historical reference, this package was previously installed by adding to your application's `shard.yml`:
1114

1215
```yaml
1316
dependencies:
1417
kemal-csrf:
1518
github: kemalcr/kemal-csrf
1619
```
1720
21+
**For new projects, use kemal-session:**
22+
23+
```yaml
24+
dependencies:
25+
kemal-session:
26+
github: kemalcr/kemal-session
27+
```
28+
1829
1930
## Usage
2031
32+
> **Important: This package is deprecated. For current CSRF protection, please refer to the [kemal-session documentation](https://github.com/kemalcr/kemal-session).**
33+
34+
### Historical Usage (Deprecated)
35+
2136
Basic Use
2237
```crystal
2338
require "kemal-csrf"

0 commit comments

Comments
 (0)