chore: add readmes to prep for alpha release

airjp73 · Jun 9, 2024 · 53df8a4 · 53df8a4
1 parent 9f9e8a5
commit 53df8a4
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 17 deletions.
diff --git a/packages/core/README.md 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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",