diff --git a/README.md b/README.md index e6ae36a..2d73dd7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,31 @@ # zod-pocketbase-continued -Zod tooling for your Pocketbase instance. +Zod tooling for your PocketBase instance. -This repo i a continuation of [Gregory Bouteiller's zod-pocketbase](https://github.com/gbouteiller/zod-pocketbase), since the repo was outdated for 10 months. +This repository is a continuation of [Gregory Bouteiller's zod-pocketbase](https://github.com/gbouteiller/zod-pocketbase), as the original repository was outdated for 10 months. -[Docs are compatible](https://zod-pocketbase.vercel.app) +## Documentation -## Licensing +[Old documentation is compatible with the current version](https://zod-pocketbase.vercel.app) -[Original MIT License](./LICENSE). +## Compatibility + +- **PocketBase**: v0.30.0 +- **PocketBase JS SDK**: v0.26.2 + +## Changes from Original + +### Project Structure +- Removed `doc/`, `playground/` and monorepo configuration +- Replaced `pnpm` and `node` in favor of `bun` +- Switched `.github/` to `.gitea/` and `gh` to `tea` + +### Dependencies & Code +- Updated all npm dependencies (except `zod`, which was only updated to the latest 3 version) +- Removed unused dependencies +- Fixed `getPocketbase` function in `sdk.ts` to match the latest PocketBase version +- Implemented most TODOs left in `content.ts` + +## License + +[MIT License](./LICENSE)