Skip to content

Commit

Permalink
docs: (readme) update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Graeme Houston committed Nov 21, 2024
1 parent 6d1775a commit 343bc5e
Showing 1 changed file with 21 additions and 18 deletions.
39 changes: 21 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,16 @@

```bash
# npm
npm install @wll/react-sdk
npm install @wlloyalty/wll-react-sdk

# yarn
yarn add @wll/react-sdk
yarn add @wlloyalty/wll-react-sdk
```

## 💻 System Requirements

The SDK is compatible with:

- React: ^18.0.0
- React Native: >=0.70.0 <0.73.0

Expand All @@ -54,25 +55,27 @@ type(scope?): subject
```

### Types
| Type | Description |
|------|-------------|
| `feat` | New features (e.g., `feat(auth): add Google OAuth login`) |
| `fix` | Bug fixes (e.g., `fix(api): correct rate limiting logic`) |
| `hotfix` | Critical bug fixes requiring immediate deployment |
| `docs` | Documentation changes |
| `style` | Code style changes (formatting, etc) |
| `refactor` | Code changes that neither fix bugs nor add features |
| `perf` | Performance improvements |
| `test` | Adding or updating tests |
| `build` | Changes to build system or dependencies |
| `ci` | Changes to CI configuration |
| `chore` | Other changes that don't modify src or test files |
| `revert` | Reverting previous changes |
| `wip` | Work in progress |

| Type | Description |
| ---------- | --------------------------------------------------------- |
| `feat` | New features (e.g., `feat(auth): add Google OAuth login`) |
| `fix` | Bug fixes (e.g., `fix(api): correct rate limiting logic`) |
| `hotfix` | Critical bug fixes requiring immediate deployment |
| `docs` | Documentation changes |
| `style` | Code style changes (formatting, etc) |
| `refactor` | Code changes that neither fix bugs nor add features |
| `perf` | Performance improvements |
| `test` | Adding or updating tests |
| `build` | Changes to build system or dependencies |
| `ci` | Changes to CI configuration |
| `chore` | Other changes that don't modify src or test files |
| `revert` | Reverting previous changes |
| `wip` | Work in progress |

### Development Workflow

We use several tools to maintain code quality:

- **Commitlint**: Validates commit message format
- **Commitizen**: Interactive commit message formatter
- **Husky**: Git hooks for enforcing conventions
Expand All @@ -98,4 +101,4 @@ The above copyright notice and this permission notice shall be included in all c
## 🆘 Support

- [Documentation](https://react-sdk.whitelabel-loyalty.com/)
- [Issues](https://github.com/white-label-loyalty/wll-react-sdk/issues)
- [Issues](https://github.com/white-label-loyalty/wll-react-sdk/issues)

0 comments on commit 343bc5e

Please sign in to comment.