Skip to content

Commit

Permalink
docs(readme): v6 update
Browse files Browse the repository at this point in the history
  • Loading branch information
TheEdoRan committed Jan 2, 2024
1 parent 74c3f57 commit d1fe2d2
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
<a href="https://github.com/TheEdoRan/next-safe-action"><h1>next-safe-action</h1></a>
</div>

> next-safe-action is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using Zod, to let you define typesafe Server Actions and execute them inside Client Components.
> next-safe-action is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using validation libraries of your choice, to let you define typesafe Server Actions and execute them inside Client Components.

## How does it work?

Expand All @@ -16,13 +17,13 @@ https://github.com/TheEdoRan/next-safe-action/assets/1337629/7ebc398e-6c7d-49b2-
- ✅ Pretty simple
- ✅ End-to-end type safety
- ✅ Context based clients (with middlewares)
- ✅ Input validation using Zod
- ✅ Input validation using multiple validation libraries
- ✅ Advanced server error handling
- ✅ Optimistic updates

## Documentation

**Explore the documentation for version 5 of the library on the [next-safe-action website](https://next-safe-action.dev).**
**Explore the documentation for version 6 of the library on the [next-safe-action website](https://next-safe-action.dev).**

If you are looking for old versions documentation, check out:
- the [README_v3](packages/next-safe-action/README_v3.md) file for version 3.x.x.
Expand Down Expand Up @@ -50,6 +51,10 @@ Version 4.x.x of the library introduced some breaking changes to the API. Please

Version 5.x.x of the library is required for Next.js >= 14 applications. Please check out the [v4 to v5 migration guide](https://next-safe-action.dev/docs/migration-from-v4-to-v5) on the website for more information.

---

Version 6.x.x of the library lets you use validation libraries other than Zod. Please check out the [v5 to v6 migration guide](https://next-safe-action.dev/docs/migration-from-v5-to-v6) on the website for more information.

## Example

You can find a basic working implementation of the library [here](packages/example-app).
Expand Down
12 changes: 8 additions & 4 deletions packages/next-safe-action/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
> next-safe-action is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using Zod, to let you define typesafe Server Actions and execute them inside Client Components.
> next-safe-action is a library that takes full advantage of the latest and greatest Next.js, React and TypeScript features, using validation libraries of your choice, to let you define typesafe Server Actions and execute them inside Client Components.
## Documentation

**Explore the documentation for version 5 of the library on [next-safe-action website](https://next-safe-action.dev).**
**Explore the documentation for version 6 of the library on [next-safe-action website](https://next-safe-action.dev).**

## Next.js >= 14 vs 13

Expand All @@ -18,10 +18,14 @@ npm i next-safe-action # for Next.js >= 14
npm i next-safe-action@v4 # for Next.js 13
```

## Migration guide
## Migration guides

Version 4.x.x of the library introduced some breaking changes to the API. Please check out the [v3 to v4 migration guide](https://next-safe-action.dev/docs/migration-from-v3-to-v4) on the website for more information.

---

Version 5.x.x of the library is required for Next.js >= 14 applications. Please check out the [v4 to v5 migration guide](https://next-safe-action.dev/docs/migration-from-v4-to-v5) on the website for more information.
Version 5.x.x of the library is required for Next.js >= 14 applications. Please check out the [v4 to v5 migration guide](https://next-safe-action.dev/docs/migration-from-v4-to-v5) on the website for more information.

---

Version 6.x.x of the library lets you use validation libraries other than Zod. Please check out the [v5 to v6 migration guide](https://next-safe-action.dev/docs/migration-from-v5-to-v6) on the website for more information.

0 comments on commit d1fe2d2

Please sign in to comment.