notform 1.0.7 → 2.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +23 -10
  3. package/dist/index.d.ts +2188 -380
  4. package/dist/index.js +0 -569
  5. package/package.json +25 -36
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2025 NotForm
3
+ Copyright (c) 2025 Favour Emeka
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,16 +1,29 @@
1
- # notform
1
+ # vue-components-starter
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/notform.svg?style=flat-square)](https://www.npmjs.com/package/notform)
4
- [![npm downloads](https://img.shields.io/npm/dm/notform.svg?style=flat-square)](https://www.npmjs.com/package/notform)
5
- [![license](https://img.shields.io/github/license/favorodera/notform.svg?style=flat-square)](https://github.com/favorodera/notform/blob/main/LICENSE)
6
- [![Bundle Size](https://img.shields.io/bundlephobia/minzip/notform.svg?style=flat-square)](https://bundlephobia.com/package/notform)
3
+ A starter for creating a Vue component library.
7
4
 
8
- **The core engine for "Vue Forms Without the Friction."**
5
+ ## Development
9
6
 
10
- `notform` is the backbone of the NotForm ecosystem, providing the core composables and state management logic for building robust forms in Vue 3.
7
+ - Install dependencies:
11
8
 
12
- ## Documentation
9
+ ```bash
10
+ npm install
11
+ ```
13
12
 
14
- For detailed guides, API reference, and examples, visit:
15
- **[notform-docs.vercel.app](https://notform-docs.vercel.app/)**
13
+ - Run the playground:
16
14
 
15
+ ```bash
16
+ npm run playground
17
+ ```
18
+
19
+ - Run the unit tests:
20
+
21
+ ```bash
22
+ npm run test
23
+ ```
24
+
25
+ - Build the library:
26
+
27
+ ```bash
28
+ npm run build
29
+ ```