Skip to content

Commit 5e27ce8

Browse files
authored
Merge pull request #1 from TheOluwafemi/fix-update-documentation
fix: update documentation
2 parents db6fefc + b30e7c9 commit 5e27ce8

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ A simple, powerful form validation library for Vue 3 that makes form handling ef
99

1010
> **Perfect for**: Vue 3 applications that need robust form validation without the complexity of learning Zod schemas directly.
1111
12-
## 📋 Table of Contents
12+
## Table of Contents
1313

1414
- [Features](#-features)
1515
- [Installation](#-installation)
@@ -23,17 +23,17 @@ A simple, powerful form validation library for Vue 3 that makes form handling ef
2323

2424
## ✨ Features
2525

26-
- **🎯 Declarative Schema Definition**: Define validation rules using simple configuration objects
27-
- **🔷 TypeScript Support**: Full type safety with excellent IntelliSense
28-
- **⚛️ Vue 3 Native**: Built with Composition API for seamless integration
29-
- **🚫 Zero Zod Knowledge Required**: Abstract away complex Zod syntax
30-
- **🔄 Reactive State Management**: Real-time form state with Vue's reactivity
31-
- **📋 Comprehensive Field Types**: Support for all common form field types
32-
- ** Flexible Validation**: Field-level and form-level validation with custom messages
33-
- **🏭 Production Ready**: Robust error handling and edge case management
34-
- ** Lightweight**: Powered by Zod under the hood for reliable validation
26+
- ** Declarative Schema Definition**: Define validation rules using simple configuration objects
27+
- ** TypeScript Support**: Full type safety with excellent IntelliSense
28+
- ** Vue 3 Native**: Built with Composition API for seamless integration
29+
- ** Zero Zod Knowledge Required**: Abstract away complex Zod syntax
30+
- ** Reactive State Management**: Real-time form state with Vue's reactivity
31+
- ** Comprehensive Field Types**: Support for all common form field types
32+
- ** Flexible Validation**: Field-level and form-level validation with custom messages
33+
- ** Production Ready**: Robust error handling and edge case management
34+
- ** Lightweight**: Powered by Zod under the hood for reliable validation
3535

36-
## 📦 Installation
36+
## Installation
3737

3838
```bash
3939
# npm
@@ -51,7 +51,7 @@ pnpm add vue-form-manager
5151
- Vue 3.x
5252
- Node.js ≥ 20.0.0
5353

54-
## 🚀 Quick Start
54+
## Quick Start
5555

5656
```vue
5757
<template>
@@ -107,9 +107,9 @@ const handleSubmit = () => {
107107
</script>
108108
```
109109

110-
## 📚 Complete Field Type Guide
110+
## Complete Field Type Guide
111111

112-
### 🔤 String Fields
112+
### String Fields
113113

114114
```typescript
115115
const { schema, initialValues } = createSchema({
@@ -124,7 +124,7 @@ const { schema, initialValues } = createSchema({
124124
})
125125
```
126126

127-
### 📧 Email Fields
127+
### Email Fields
128128

129129
```typescript
130130
const { schema, initialValues } = createSchema({
@@ -136,7 +136,7 @@ const { schema, initialValues } = createSchema({
136136
})
137137
```
138138

139-
### 🔢 Number Fields
139+
### Number Fields
140140

141141
```typescript
142142
const { schema, initialValues } = createSchema({
@@ -148,7 +148,7 @@ const { schema, initialValues } = createSchema({
148148
})
149149
```
150150

151-
### 🌐 URL Fields
151+
### URL Fields
152152

153153
```typescript
154154
const { schema, initialValues } = createSchema({
@@ -160,7 +160,7 @@ const { schema, initialValues } = createSchema({
160160
})
161161
```
162162

163-
### 📅 Date Fields
163+
### Date Fields
164164

165165
```typescript
166166
const { schema, initialValues } = createSchema({
@@ -172,7 +172,7 @@ const { schema, initialValues } = createSchema({
172172
})
173173
```
174174

175-
### Boolean Fields
175+
### Boolean Fields
176176

177177
```typescript
178178
const { schema, initialValues } = createSchema({
@@ -184,7 +184,7 @@ const { schema, initialValues } = createSchema({
184184
})
185185
```
186186

187-
### 📋 Enum Fields (Select/Dropdown)
187+
### Enum Fields (Select/Dropdown)
188188

189189
```typescript
190190
const { schema, initialValues } = createSchema({
@@ -196,7 +196,7 @@ const { schema, initialValues } = createSchema({
196196
})
197197
```
198198

199-
### 📦 Array Fields
199+
### Array Fields
200200

201201
```typescript
202202
const { schema, initialValues } = createSchema({
@@ -232,7 +232,7 @@ const { schema, initialValues } = createSchema({
232232
})
233233
```
234234

235-
## 🛠️ API Reference
235+
## API Reference
236236

237237
### `createSchema(config)`
238238

@@ -275,7 +275,7 @@ Returns form state and management functions:
275275
}
276276
```
277277

278-
## 📝 Field Configuration
278+
## Field Configuration
279279

280280
```typescript
281281
interface FieldConfig {
@@ -302,7 +302,7 @@ interface FieldConfig {
302302
}
303303
```
304304

305-
## 🔷 TypeScript Support
305+
## TypeScript Support
306306

307307
The library is fully typed with TypeScript. Import types for better development experience:
308308

@@ -329,14 +329,14 @@ const { schema, initialValues } = createSchema(schemaConfig)
329329
const formControls: UseFormReturn = useForm({ schema, initialValues })
330330
```
331331

332-
## 🎯 Best Practices
332+
## Best Practices
333333

334334
1. **Consistent Error Messages**: Use clear, user-friendly validation messages
335335
2. **Validation Timing**: Use `@blur` for validation, `@input` for clearing errors
336336
3. **TypeScript**: Type your configurations for better development experience
337337
4. **Form Organization**: Group related fields logically
338338

339-
## 🤝 Contributing
339+
## Contributing
340340

341341
1. Fork the repository
342342
2. Create your feature branch: `git checkout -b feat/amazing-feature`
@@ -356,10 +356,10 @@ This project uses [Conventional Commits](https://conventionalcommits.org/):
356356
- `test:` - Test updates
357357
- `chore:` - Maintenance tasks
358358

359-
## 📄 License
359+
## License
360360

361361
MIT License - see the [LICENSE](LICENSE) file for details.
362362

363-
## Show Your Support
363+
## Show Your Support
364364

365365
If this project helped you, please consider giving it a ⭐ on [GitHub](https://github.com/TheOluwafemi/vue-form-manager)!

0 commit comments

Comments
 (0)