Skip to content

Commit d10b71f

Browse files
committed
docs(session): doc adding features using cargo add
1 parent f233997 commit d10b71f

File tree

2 files changed

+16
-18
lines changed

2 files changed

+16
-18
lines changed

actix-session/README.md

+8-16
Original file line numberDiff line numberDiff line change
@@ -94,34 +94,26 @@ By default, `actix-session` does not provide any storage backend to retrieve and
9494

9595
- a purely cookie-based "backend", [`CookieSessionStore`], using the `cookie-session` feature flag.
9696

97-
```toml
98-
[dependencies]
99-
# ...
100-
actix-session = { version = "...", features = ["cookie-session"] }
97+
```console
98+
cargo add actix-session --features=cookie-session
10199
```
102100

103101
- a Redis-based backend via the [`redis`] crate, [`RedisSessionStore`], using the `redis-session` feature flag.
104102

105-
```toml
106-
[dependencies]
107-
# ...
108-
actix-session = { version = "...", features = ["redis-session"] }
103+
```console
104+
cargo add actix-session --features=redis-session
109105
```
110106

111107
Add the `redis-session-native-tls` feature flag if you want to connect to Redis using a secure connection (via the `native-tls` crate):
112108

113-
```toml
114-
[dependencies]
115-
# ...
116-
actix-session = { version = "...", features = ["redis-session-native-tls"] }
109+
```console
110+
cargo add actix-session --features=redis-session-native-tls
117111
```
118112

119113
If you, instead, prefer depending on `rustls`, use the `redis-session-rustls` feature flag:
120114

121-
```toml
122-
[dependencies]
123-
# ...
124-
actix-session = { version = "...", features = ["redis-session-rustls"] }
115+
```console
116+
cargo add actix-session --features=redis-session-rustls
125117
```
126118

127119
You can implement your own session storage backend using the [`SessionStore`] trait.

justfile

+8-2
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,17 @@ msrv_rustup := "+" + msrv
1919
clippy:
2020
cargo {{ toolchain }} clippy --workspace --all-targets --all-features
2121

22-
# Format workspace.
22+
# Format project.
2323
[group("lint")]
2424
fmt: update-readmes
2525
cargo +nightly fmt
26-
fd --hidden --extension=yml --extension=md --exec-batch npx -y prettier --write
26+
fd --type=file --hidden --extension=yml --extension=md --exec-batch npx -y prettier --write
27+
28+
# Check project.
29+
[group("lint")]
30+
check:
31+
cargo +nightly fmt -- --check
32+
fd --type=file --hidden --extension=yml --extension=md --exec-batch npx -y prettier --check
2733

2834
# Update READMEs from crate root documentation.
2935
[group("lint")]

0 commit comments

Comments
 (0)