Skip to content

Commit 4d85566

Browse files
committed
document features
1 parent 29f8f06 commit 4d85566

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,22 @@
1616
[version-badge]: https://img.shields.io/crates/v/async-sqlx-session.svg?style=flat-square
1717

1818
## Installation
19-
```sh
20-
$ cargo add async-sqlx-session
19+
### sqlite:
20+
21+
```toml
22+
async-sqlx-session = { version = "0.2.0", features = ["sqlite"] }
23+
```
24+
25+
### postgres:
26+
27+
```toml
28+
async-sqlx-session = { version = "0.2.0", features = ["pg"] }
2129
```
2230

31+
32+
33+
## Cargo Features:
34+
2335
## Safety
2436
This crate uses ``#![deny(unsafe_code)]`` to ensure everything is implemented in
2537
100% Safe Rust.

src/lib.rs

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
//! # async-sqlx-session
22
//!
3-
//! This crate currently only provides a sqlite session store, but
4-
//! will eventually support other databases as well, configurable
5-
//! through a feature flag.
6-
//!
7-
//! For now, see the documentation for
8-
//! [`SqliteStore`](crate::SqliteSessionStore)
3+
//! This crate currently provides two session stores: [`PostgresSessionStore`] and [`SqliteSessionStore`], each of which is enabled by a feature flag.
4+
//! To use `SqliteSessionStore`, enable the `sqlite` feature on this crate.
5+
//! To use `PostgresSessionStore`, enable the `pg` feature on this crate.
96
#![forbid(unsafe_code, future_incompatible)]
107
#![deny(
118
missing_debug_implementations,

0 commit comments

Comments
 (0)