@viveksinghind/narrative-form-core 1.0.0 → 1.0.1
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.
- package/README.md +27 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# @viveksinghind/narrative-form-core
|
|
2
|
+
|
|
3
|
+
Core logic and state management for Narrative Form, a typewriter-style signup flow.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @viveksinghind/narrative-form-core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- Platform-agnostic state machine for handling typewriter form logic
|
|
14
|
+
- Robust validation engine with built-in validators (email, required, min length, etc.)
|
|
15
|
+
- Async validation support
|
|
16
|
+
- First-class TypeScript support
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
You probably don't want to use this package directly unless you are building a custom UI wrapper. Instead, use one of our framework-specific packages:
|
|
21
|
+
|
|
22
|
+
- [@viveksinghind/narrative-form-react](https://www.npmjs.com/package/@viveksinghind/narrative-form-react)
|
|
23
|
+
- [@viveksinghind/narrative-form-angular](https://www.npmjs.com/package/@viveksinghind/narrative-form-angular)
|
|
24
|
+
|
|
25
|
+
## License
|
|
26
|
+
|
|
27
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@viveksinghind/narrative-form-core",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "Core logic for narrative-form — framework agnostic typewriter form engine",
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"description": "Core logic and state machine for narrative-form — framework agnostic typewriter form engine",
|
|
5
5
|
"author": "Vivek Singh <vivekSinghInd>",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"main": "dist/index.cjs",
|