Skip to content

Commit

Permalink
add feature flags to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nicoburniske committed Feb 21, 2024
1 parent 1d5bec0 commit e405ad7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,20 @@ Leptos Query focuses on simplifying your data fetching process and keeping your

- **Introspection & Debugging**: Leptos Query provides [devtools](https://crates.io/crates/leptos_query_devtools), so you can make sure everything's working as intended.

## Feature Flags
- `csr` Client-side rendering: Use queries on the client.
- `ssr` Server-side rendering: Initiate queries on the server during SSR.
- `hydrate` Hydration: Ensure that queries are hydrated on the client, when using server-side rendering.
- `local_storage` - Enables local storage persistance for queries.
- `index_db` - Enables index db persistance for queries.

## Version compatibility for Leptos and Leptos Query

The table below shows the compatible versions of `leptos_query` for each `leptos` version. Ensure you are using compatible versions to avoid potential issues.

| `leptos` version | `leptos_query` version |
|------------------|------------------------|
| 0.6.* | 0.4.* or 0.5.* |
| 0.6.* | 0.5.* or 0.4.* |
| 0.5.* | 0.3.* |


Expand Down

0 comments on commit e405ad7

Please sign in to comment.