redgin-store 0.1.0 → 0.1.2

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 (2) hide show
  1. package/README.md +14 -0
  2. package/package.json +29 -7
package/README.md CHANGED
@@ -19,6 +19,20 @@ RedGin Store was built to provide Single Source of Truth that is:
19
19
  * ⚛️ Immutable & Type-Safe: Uses reference-based dirty checking to ensure high-performance updates.
20
20
  * 📦 Zero Dependencies: Extremely small footprint (~1kb).
21
21
 
22
+ # Installation
23
+
24
+ ### Via npm
25
+ ```bash
26
+ npm i redgin-store
27
+ ```
28
+
29
+ ## Via CDN
30
+
31
+ ```js
32
+ <script type="module" src="https://cdn.jsdelivr.net/npm/redgin-store@latest/dist/redgin-store.min.js"></script>
33
+ ```
34
+
35
+
22
36
  # Quick Start
23
37
  1. Define your Store
24
38
  Create a singleton instance. Pass a storageKey as the second argument to enable persistence.
package/package.json CHANGED
@@ -1,20 +1,42 @@
1
1
  {
2
2
  "name": "redgin-store",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "type": "module",
5
+ "main": "./dist/redgin-store.min.js",
6
+ "module": "./dist/redgin-store.min.js",
7
+ "types": "./dist/store.d.ts",
8
+ "keywords": [
9
+ "redgin",
10
+ "web-components",
11
+ "state-management",
12
+ "store",
13
+ "reactive",
14
+ "persistence",
15
+ "localstorage",
16
+ "custom-elements",
17
+ "typescript",
18
+ "lightweight",
19
+ "micro-state",
20
+ "observable",
21
+ "batch-updates"
22
+ ],
23
+ "description": "A lightweight state management library for web components, built on top of Redgin. Provides a simple and efficient way to manage state in your web applications.",
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "https://github.com/josnin/redgin-store.git"
27
+ },
28
+ "license": "MIT",
5
29
  "scripts": {
6
30
  "dev": "vite",
7
31
  "build": "esbuild src/store.ts --bundle --minify --format=esm --external:redgin --outfile=dist/redgin-store.min.js",
8
32
  "check-types": "tsc --noEmit"
9
33
  },
10
- "peerDependencies": {
11
- "redgin": ">=0.2.2"
12
- },
13
34
  "devDependencies": {
14
35
  "esbuild": "^0.20.0",
15
36
  "typescript": "^5.0.0",
16
- "vite": "^5.0.0",
17
- "redgin": "latest"
37
+ "vite": "^5.0.0"
38
+ },
39
+ "dependencies": {
40
+ "redgin": "^0.2.2"
18
41
  }
19
42
  }
20
-