@wlloyalty/wll-react-sdk 1.0.21 → 1.0.24
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 +24 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,23 +17,24 @@
|
|
|
17
17
|
|
|
18
18
|
## 📚 Documentation
|
|
19
19
|
|
|
20
|
-
- [Getting Started Guide](https://
|
|
21
|
-
- [Component Library](https://
|
|
20
|
+
- [Getting Started Guide](https://react-sdk.whitelabel-loyalty.com/guide/getting-started)
|
|
21
|
+
- [Component Library](https://react-sdk.whitelabel-loyalty.com/components/)
|
|
22
22
|
- [Live Storybook Demo](https://66c36701bb14ec551f38279c-ueompbfvfq.chromatic.com/)
|
|
23
23
|
|
|
24
24
|
## 🚀 Quick Start
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
27
|
# npm
|
|
28
|
-
npm install @wll
|
|
28
|
+
npm install @wlloyalty/wll-react-sdk
|
|
29
29
|
|
|
30
30
|
# yarn
|
|
31
|
-
yarn add @wll
|
|
31
|
+
yarn add @wlloyalty/wll-react-sdk
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
## 💻 System Requirements
|
|
35
35
|
|
|
36
36
|
The SDK is compatible with:
|
|
37
|
+
|
|
37
38
|
- React: ^18.0.0
|
|
38
39
|
- React Native: >=0.70.0 <0.73.0
|
|
39
40
|
|
|
@@ -54,25 +55,27 @@ type(scope?): subject
|
|
|
54
55
|
```
|
|
55
56
|
|
|
56
57
|
### Types
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
|
60
|
-
| `
|
|
61
|
-
| `
|
|
62
|
-
| `
|
|
63
|
-
| `
|
|
64
|
-
| `
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
70
|
-
| `
|
|
71
|
-
| `
|
|
58
|
+
|
|
59
|
+
| Type | Description |
|
|
60
|
+
| ---------- | --------------------------------------------------------- |
|
|
61
|
+
| `feat` | New features (e.g., `feat(auth): add Google OAuth login`) |
|
|
62
|
+
| `fix` | Bug fixes (e.g., `fix(api): correct rate limiting logic`) |
|
|
63
|
+
| `hotfix` | Critical bug fixes requiring immediate deployment |
|
|
64
|
+
| `docs` | Documentation changes |
|
|
65
|
+
| `style` | Code style changes (formatting, etc) |
|
|
66
|
+
| `refactor` | Code changes that neither fix bugs nor add features |
|
|
67
|
+
| `perf` | Performance improvements |
|
|
68
|
+
| `test` | Adding or updating tests |
|
|
69
|
+
| `build` | Changes to build system or dependencies |
|
|
70
|
+
| `ci` | Changes to CI configuration |
|
|
71
|
+
| `chore` | Other changes that don't modify src or test files |
|
|
72
|
+
| `revert` | Reverting previous changes |
|
|
73
|
+
| `wip` | Work in progress |
|
|
72
74
|
|
|
73
75
|
### Development Workflow
|
|
74
76
|
|
|
75
77
|
We use several tools to maintain code quality:
|
|
78
|
+
|
|
76
79
|
- **Commitlint**: Validates commit message format
|
|
77
80
|
- **Commitizen**: Interactive commit message formatter
|
|
78
81
|
- **Husky**: Git hooks for enforcing conventions
|
|
@@ -97,5 +100,5 @@ The above copyright notice and this permission notice shall be included in all c
|
|
|
97
100
|
|
|
98
101
|
## 🆘 Support
|
|
99
102
|
|
|
100
|
-
- [Documentation](https://
|
|
101
|
-
- [Issues](https://github.com/white-label-loyalty/wll-react-sdk/issues)
|
|
103
|
+
- [Documentation](https://react-sdk.whitelabel-loyalty.com/)
|
|
104
|
+
- [Issues](https://github.com/white-label-loyalty/wll-react-sdk/issues)
|