#4 Readme (#6)

* add example project

* add example

* change name of example folder

* update readme

* update readme

* remove logo

* add example link

* remove example from build

.npmignore

@@ -3,6 +3,7 @@
 .gitignore
 .github
 src
+example
 pnpm-lock.yaml
 tsconfig.json
 vitest.config.ts

README.md

@@ -1 +1,95 @@
-# react-form-hook
+
+# React Form Hook
+
+A model-driven, simple and typesafe approach to forms in React
+
+## Features
+
+- Simple to use
+- Typesafe from start to end
+- Lightweight
+- Support for Zod
+
+
+## Installation and usage
+
+First install react-form-hook:
+
+```bash
+npm i @deadcow-enterprises/react-form-hook
+```
+
+then use it in your application
+
+```javascript
+import { useForm } from "@deadcow-enterprises/react-form-hook";
+import { z } from "zod";
+
+type LoginModel = {
+  username: string;
+  password: string;
+};
+
+function App() {
+  const form = useForm<LoginModel>({
+    username: {
+      value: "",
+      validator: z.string().min(1, "Username is required"),
+    },
+    password: {
+      value: "",
+      validator: z.string().min(1, "Password is required"),
+    },
+  });
+  const login = (formValue: LoginModel) => {
+    // do something with formValue here like send it to the server
+    console.log(formValue);
+  };
+  return (
+    <form onSubmit={form.handleSubmit(login)}>
+      <label htmlFor="username">
+        Username
+        <input
+          type="text"
+          name="username"
+          id="username"
+          value={form.value.username}
+          onChange={(ev) => {
+            form.setValue("username", ev.target.value);
+          }}
+        />
+        {form.errors.username?.map((err, i) => (
+          <span className="error" key={i}>
+            {err}
+          </span>
+        ))}
+      </label>
+      <label htmlFor="password">
+        Password
+        <input
+          type="password"
+          name="password"
+          id="password"
+          value={form.value.password}
+          onChange={(ev) => {
+            form.setValue("password", ev.target.value);
+          }}
+        />
+        {form.errors.username?.map((err, i) => (
+          <span className="error" key={i}>
+            {err}
+          </span>
+        ))}
+      </label>
+
+      <button>Submit</button>
+    </form>
+  );
+}
+```
+
+You can also check the example project repo [here](https://github.com/DeadCowDev/react-form-hook/tree/main/example)
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+

example/.eslintrc.cjs

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}

example/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

example/README.md

@@ -0,0 +1,27 @@
+# React + TypeScript + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+## Expanding the ESLint configuration
+
+If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+
+- Configure the top-level `parserOptions` property like this:
+
+```js
+   parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: ['./tsconfig.json', './tsconfig.node.json'],
+    tsconfigRootDir: __dirname,
+   },
+```
+
+- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
+- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
+- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

example/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Vite + React + TS</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

example/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "example-react",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@deadcow-enterprises/react-form-hook": "^0.0.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.15",
+    "@types/react-dom": "^18.2.7",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "@vitejs/plugin-react": "^4.0.3",
+    "eslint": "^8.45.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.3",
+    "typescript": "^5.0.2",
+    "vite": "^4.4.5"
+  }
+}