From 53df8a4da1554865b3c8cf2bfd5354c74fd1d7d3 Mon Sep 17 00:00:00 2001 From: Aaron Pettengill Date: Sat, 8 Jun 2024 20:32:01 -0400 Subject: [PATCH] chore: add readmes to prep for alpha release --- packages/core/README.md | 10 ++++++++++ packages/core/package.json | 5 ++--- packages/react/README.md | 9 +++++++++ packages/react/package.json | 3 +-- packages/remix/README.md | 9 +++++++++ packages/remix/package.json | 3 +-- packages/yup/README.md | 9 +++++---- packages/yup/package.json | 2 +- packages/zod/README.md | 9 +++++---- packages/zod/package.json | 2 +- 10 files changed, 44 insertions(+), 17 deletions(-) create mode 100644 packages/core/README.md create mode 100644 packages/react/README.md create mode 100644 packages/remix/README.md diff --git a/packages/core/README.md b/packages/core/README.md new file mode 100644 index 00000000..7838dd06 --- /dev/null +++ b/packages/core/README.md @@ -0,0 +1,10 @@ +# RVF React + +The core implementation of [RVF](https://github.com/airjp73/remix-validated-form). +This is primarily used internally by the other adapters. +It isn't recommended for use by most people. + +## ALPHA RELEASE + +This is an alpha version. There WILL be breaking API changes. +Please feel free to experiment with it and give feedback, but don't use it in production. diff --git a/packages/core/package.json b/packages/core/package.json index 4eda9033..3fec4049 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@rvf/core", - "version": "6.0.0", + "version": "0.0.1", "description": "Easy, predictable form state management for React", "main": "./dist/index.cjs.js", "module": "./dist/index.esm.js", @@ -13,8 +13,7 @@ "scripts": { "dev": "tsup --watch", "build": "tsup", - "prepublishOnly": "cp ../../README.md ./README.md && npm run build", - "postpublish": "rm ./README.md", + "prepublishOnly": "bun run build", "typecheck": "tsc --noEmit" }, "author": { diff --git a/packages/react/README.md b/packages/react/README.md new file mode 100644 index 00000000..fd1d54ae --- /dev/null +++ b/packages/react/README.md @@ -0,0 +1,9 @@ +# RVF React + +The React adapter for [RVF](https://github.com/airjp73/remix-validated-form). +This is the package you should use if you aren't using Remix. + +## ALPHA RELEASE + +This is an alpha version. There WILL be breaking API changes. +Please feel free to experiment with it and give feedback, but don't use it in production. diff --git a/packages/react/package.json b/packages/react/package.json index c7d8df7b..3f9eb95b 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -13,8 +13,7 @@ "scripts": { "dev": "tsup --watch", "build": "tsup", - "prepublishOnly": "cp ../../README.md ./README.md && npm run build", - "postpublish": "rm ./README.md", + "prepublishOnly": "bun run build", "typecheck": "tsc --noEmit" }, "author": { diff --git a/packages/remix/README.md b/packages/remix/README.md new file mode 100644 index 00000000..4bc48961 --- /dev/null +++ b/packages/remix/README.md @@ -0,0 +1,9 @@ +# RVF Remix + +The Remix adapter for [RVF](https://github.com/airjp73/remix-validated-form). +This is the package you should use if you are using Remix. + +## ALPHA RELEASE + +This is an alpha version. There WILL be breaking API changes. +Please feel free to experiment with it and give feedback, but don't use it in production. diff --git a/packages/remix/package.json b/packages/remix/package.json index 7804c311..9e3d2043 100644 --- a/packages/remix/package.json +++ b/packages/remix/package.json @@ -13,8 +13,7 @@ "scripts": { "dev": "tsup --watch", "build": "tsup", - "prepublishOnly": "cp ../../README.md ./README.md && npm run build", - "postpublish": "rm ./README.md", + "prepublishOnly": "bun run build", "typecheck": "tsc --noEmit" }, "author": { diff --git a/packages/yup/README.md b/packages/yup/README.md index de9c1e74..4f41065b 100644 --- a/packages/yup/README.md +++ b/packages/yup/README.md @@ -1,7 +1,8 @@ -# @rvf/yup +# RVF Yup -Yup adapter for [remix-validated-form](https://github.com/airjp73/remix-validated-form). +The Yup adapter for [RVF](https://github.com/airjp73/remix-validated-form). -## Docs +## ALPHA RELEASE -The docs are located a [remix-validated-form.io](https://www.remix-validated-form.io). +This is an alpha version. There WILL be breaking API changes. +Please feel free to experiment with it and give feedback, but don't use it in production. diff --git a/packages/yup/package.json b/packages/yup/package.json index 539e5faf..c9b02d80 100644 --- a/packages/yup/package.json +++ b/packages/yup/package.json @@ -1,6 +1,6 @@ { "name": "@rvf/yup", - "version": "4.0.0", + "version": "0.0.1", "main": "./dist/index.cjs.js", "module": "./dist/index.esm.js", "types": "./dist/index.d.ts", diff --git a/packages/zod/README.md b/packages/zod/README.md index 8eb7bc05..3ca19044 100644 --- a/packages/zod/README.md +++ b/packages/zod/README.md @@ -1,7 +1,8 @@ -# @rvf/zod +# RVF Zod -Zod adapter for [remix-validated-form](https://github.com/airjp73/remix-validated-form). +The Zod adapter for [RVF](https://github.com/airjp73/remix-validated-form). -## Docs +## ALPHA RELEASE -The docs are located a [remix-validated-form.io](https://www.remix-validated-form.io). +This is an alpha version. There WILL be breaking API changes. +Please feel free to experiment with it and give feedback, but don't use it in production. diff --git a/packages/zod/package.json b/packages/zod/package.json index 2aa28303..b4902513 100644 --- a/packages/zod/package.json +++ b/packages/zod/package.json @@ -1,6 +1,6 @@ { "name": "@rvf/zod", - "version": "3.0.0", + "version": "0.0.1", "main": "./dist/index.cjs.js", "module": "./dist/index.esm.js", "types": "./dist/index.d.ts",