Rename library

stevent-team · Jul 4, 2023 · d61daf8 · d61daf8
1 parent 6686b63
commit d61daf8
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1,22 +1,25 @@
-# 🌲 Fir - Forms in React
+# 🌲 React Zoom Form
+
+[![npm version](https://img.shields.io/npm/v/@stevent-team/react-zoom-form)](https://www.npmjs.com/package/@stevent-team/react-zoom-form)
+[![minzip size](https://img.shields.io/bundlephobia/minzip/@stevent-team/react-zoom-form)](https://bundlephobia.com/package/@stevent-team/react-zoom-form)
 
 > **Warning**<br>
-> Fir is in alpha, and the API may change entirely within minor releases. Please use at your own risk.
+> React Zoom Form is in alpha, and the API may change entirely within minor releases. Please use at your own risk.
 
 Typescript-first, hook-based forms using React, powered by [Zod](https://github.com/colinhacks/zod). Inspired by [react-hook-form](https://github.com/react-hook-form/react-hook-form) and [react-zorm](https://github.com/esamattis/react-zorm).
 
 ## Usage
 
-Install `fir` and `zod`
+Install `react-zoom-form` and `zod`
 
 ```bash
-yarn add @stevent-team/fir zod
+yarn add @stevent-team/react-zoom-form zod
 ```
 
 Example usage:
 
 ```tsx
-import { useForm, useField, Field } from '@stevent-team/fir'
+import { useForm, useField, Field } from '@stevent-team/react-zoom-form'
 import { z } from 'zod'
 
 // Define the structure and validation of your form

diff --git a/example/App.tsx b/example/App.tsx
@@ -1,4 +1,4 @@
-import { SubmitHandler, useForm, Field, useField } from '@stevent-team/fir'
+import { SubmitHandler, useForm, Field, useField } from '@stevent-team/react-zoom-form'
 import { ZodIssue, z } from 'zod'
 
 // Define the structure and validation of your form

diff --git a/index.html b/index.html
@@ -4,7 +4,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="stylesheet" href="./example/style.css">
-    <title>Fir Example</title>
+    <title>React Zoom Form Example</title>
   </head>
   <body>
     <div id="app"></div>

diff --git a/package.json b/package.json
@@ -1,15 +1,15 @@
 {
-  "name": "@stevent-team/fir",
+  "name": "@stevent-team/react-zoom-form",
   "version": "0.0.1",
-  "description": "Forms in React",
+  "description": "React forms powered by Zod",
   "keywords": [
     "react",
     "hooks",
-    "fir",
+    "zoom",
     "forms",
     "zod"
   ],
-  "repository": "https://github.com/stevent-team/fir",
+  "repository": "https://github.com/stevent-team/react-zoom-form",
   "author": "Stevent Team (https://stevent.club)",
   "license": "MIT",
   "scripts": {
@@ -22,13 +22,13 @@
   "files": [
     "dist"
   ],
-  "module": "./dist/fir.js",
-  "main": "./dist/fir.umd.cjs",
-  "types": "./dist/fir.d.ts",
+  "module": "./dist/react-zoom-form.js",
+  "main": "./dist/react-zoom-form.umd.cjs",
+  "types": "./dist/react-zoom-form.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/fir.js",
-      "require": "./dist/fir.umd.cjs"
+      "import": "./dist/react-zoom-form.js",
+      "require": "./dist/react-zoom-form.umd.cjs"
     }
   },
   "peerDependencies": {

diff --git a/test/basic.test.tsx b/test/basic.test.tsx
@@ -1,7 +1,7 @@
 import { describe, it, expect, vi } from 'vitest'
 import { render, screen } from '@testing-library/react'
 import { ZodIssue, z } from 'zod'
-import { SubmitHandler, useForm } from '@stevent-team/fir'
+import { SubmitHandler, useForm } from '@stevent-team/react-zoom-form'
 import userEvent from '@testing-library/user-event'
 
 const schema = z.object({

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "paths": {
-      "@stevent-team/fir": ["./lib/index.ts"] // Allows importing library from realistic path in demo
+      "@stevent-team/react-zoom-form": ["./lib/index.ts"] // Allows importing library from realistic path in demo
     },
     "target": "ESNext",
     "jsx": "react-jsx",

diff --git a/vite.config.ts b/vite.config.ts
@@ -10,14 +10,14 @@ export default defineConfig({
   ],
   resolve: {
     alias: {
-      '@stevent-team/fir': resolve(__dirname, 'lib/index.ts')
+      '@stevent-team/react-zoom-form': resolve(__dirname, 'lib/index.ts')
     }
   },
   build: {
     lib: {
       entry: resolve(__dirname, 'lib/index.ts'),
-      name: 'fir',
-      fileName: 'fir',
+      name: 'react-zoom-form',
+      fileName: 'react-zoom-form',
     },
   },
   test: {