@codebelt/classy-store 0.1.2 → 0.1.3
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 +48 -0
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @codebelt/classy-store
|
|
2
|
+
|
|
3
|
+
**Class-based reactive state management for React.**
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@codebelt/classy-store)
|
|
6
|
+
[](https://github.com/codebelt/classy-store/actions/workflows/ci.yml)
|
|
7
|
+
[](https://github.com/codebelt/classy-store/blob/main/LICENSE)
|
|
8
|
+
|
|
9
|
+
## 📚 Documentation
|
|
10
|
+
|
|
11
|
+
Visit the **[Documentation Website](https://codebelt.github.io/classy-store/)** for tutorials, API reference, and examples.
|
|
12
|
+
|
|
13
|
+
## 🚀 Features
|
|
14
|
+
|
|
15
|
+
- **Class-Based**: Define state and logic using standard ES6 classes.
|
|
16
|
+
- **Reactive**: Automatic reactivity using Proxies.
|
|
17
|
+
- **React Integration**: Seamless integration with React 18+ hooks.
|
|
18
|
+
- **TypeScript**: Written in TypeScript with first-class type support.
|
|
19
|
+
|
|
20
|
+
## 📦 Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install @codebelt/classy-store
|
|
24
|
+
# or
|
|
25
|
+
bun add @codebelt/classy-store
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## 🛠️ Development
|
|
29
|
+
|
|
30
|
+
This project uses [Bun](https://bun.sh) for development.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
# Install dependencies
|
|
34
|
+
bun install
|
|
35
|
+
|
|
36
|
+
# Run tests
|
|
37
|
+
bun run test
|
|
38
|
+
|
|
39
|
+
# Run build
|
|
40
|
+
bun run build
|
|
41
|
+
|
|
42
|
+
# Start docs website locally
|
|
43
|
+
bun run docs:dev
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## 🤝 Contributing
|
|
47
|
+
|
|
48
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute and the release workflow.
|
package/package.json
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@codebelt/classy-store",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Class-based reactive state management — ES6 Proxy + immutable snapshots",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
|
-
"url": "git+https://github.com/codeBelt/classy-store.git"
|
|
7
|
+
"url": "git+https://github.com/codeBelt/classy-store.git",
|
|
8
|
+
"directory": "packages/classy-store"
|
|
8
9
|
},
|
|
9
10
|
"type": "module",
|
|
10
11
|
"main": "./dist/index.cjs",
|
|
@@ -47,7 +48,8 @@
|
|
|
47
48
|
}
|
|
48
49
|
},
|
|
49
50
|
"files": [
|
|
50
|
-
"dist"
|
|
51
|
+
"dist",
|
|
52
|
+
"README.md"
|
|
51
53
|
],
|
|
52
54
|
"scripts": {
|
|
53
55
|
"---------- Dev --------------------------------------------------------": "",
|
|
@@ -58,6 +60,7 @@
|
|
|
58
60
|
"test": "bun test",
|
|
59
61
|
"---------- Lint --------------------------------------------------------": "",
|
|
60
62
|
"typecheck": "tsc --noEmit",
|
|
63
|
+
"prepublishOnly": "cp ../../README.md .",
|
|
61
64
|
"-----------------------------------------------------------------------": ""
|
|
62
65
|
},
|
|
63
66
|
"dependencies": {
|