Skip to content

Commit a6662ff

Browse files
committed
docs: update readmes
1 parent c76ac59 commit a6662ff

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Use [Better Auth](https://better-auth.com) with [Convex](https://www.convex.dev)
2121
locally within this repo. They can be adapted for standalone use, but are
2222
intentionally not set up for it.
2323

24-
**Note:** Examples on the `main` branch may not match your version of the Better
25-
Auth component. Use the `latest` branch for the latest stable release and the
26-
`alpha` branch for the latest alpha release.
24+
**Note:** Examples on the `main` branch use the `alpha` release. If you're not
25+
installing the `alpha`, use the `latest` branch for docs and examples matching
26+
the latest stable release.
2727

2828
1. Clone or fork the repo
2929
2. Install root dependencies

examples/next/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This example shows how to use Better Auth with Convex and Next.js.
55
Note that dependencies are set up to work with the local component in this repo,
66
it is not set up for standalone use (but can be adapted).
77

8-
**Note:** Examples on the `main` branch may not match your version of the Better
9-
Auth component. Use the `latest` branch for the latest stable release and the
10-
`alpha` branch for the latest alpha release.
8+
**Note:** Examples on the `main` branch use the `alpha` release. If you're not
9+
installing the `alpha`, use the `latest` branch for docs and examples matching
10+
the latest stable release.
1111

1212
### Running the example
1313

examples/react/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This example shows how to use Better Auth with Convex and React.
55
Note that dependencies are set up to work with the local component in this repo,
66
it is not set up for standalone use (but can be adapted).
77

8-
**Note:** Examples on the `main` branch may not match your version of the Better
9-
Auth component. Use the `latest` branch for the latest stable release and the
10-
`alpha` branch for the latest alpha release.
8+
**Note:** Examples on the `main` branch use the `alpha` release. If you're not
9+
installing the `alpha`, use the `latest` branch for docs and examples matching
10+
the latest stable release.
1111

1212
### Running the example
1313

examples/tanstack-legacy/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This example shows how to use Better Auth with Convex and TanStack Start.
55
Note that dependencies are set up to work with the local component in this repo,
66
it is not set up for standalone use (but can be adapted).
77

8-
**Note:** Examples on the `main` branch may not match your version of the Better
9-
Auth component. Use the `latest` branch for the latest stable release and the
10-
`alpha` branch for the latest alpha release.
8+
**Note:** Examples on the `main` branch use the `alpha` release. If you're not
9+
installing the `alpha`, use the `latest` branch for docs and examples matching
10+
the latest stable release.
1111

1212
### Running the example
1313

examples/tanstack/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ This example shows how to use Better Auth with Convex and TanStack Start.
55
Note that dependencies are set up to work with the local component in this repo,
66
it is not set up for standalone use (but can be adapted).
77

8-
**Note:** Examples on the `main` branch may not match your version of the Better
9-
Auth component. Use the `latest` branch for the latest stable release and the
10-
`alpha` branch for the latest alpha release.
8+
**Note:** Examples on the `main` branch use the `alpha` release. If you're not
9+
installing the `alpha`, use the `latest` branch for docs and examples matching
10+
the latest stable release.
1111

1212
### Running the example
1313

0 commit comments

Comments
 (0)