Skip to content

Commit 80a1b1f

Browse files
committed
docs: update README for v3.0.0 stable, add tryout app and docs links
1 parent 4c7a598 commit 80a1b1f

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,22 @@ The most complete haptic feedback library for React Native — Core Haptics on i
66
[![npm](https://img.shields.io/npm/v/react-native-haptic-feedback)](https://www.npmjs.com/package/react-native-haptic-feedback)
77
[![npm downloads](https://img.shields.io/npm/dm/react-native-haptic-feedback)](https://www.npmjs.com/package/react-native-haptic-feedback)
88

9+
**[Full documentation →](https://mkuczera.github.io/react-native-haptic-feedback/)**
10+
911
If this library saves you time, consider [sponsoring its development](https://github.com/sponsors/mkuczera). ⭐
1012

13+
---
14+
15+
## Try it on your device
16+
17+
Want to feel the difference between every haptic type — or test your own custom pattern notation — before writing a single line of code?
18+
19+
**Haptic Feedback Tryout** is a companion app that lets you tap through all available feedback types and compose your own patterns interactively using the `o O . - =` notation.
20+
21+
[Download on the App Store](https://apps.apple.com/us/app/haptic-feedback-tryout/id6760615313) — iOS available now, Android coming soon.
22+
23+
---
24+
1125
## Contributions Welcome
1226

1327
[![Contributors](https://contrib.rocks/image?repo=mkuczera/react-native-haptic-feedback)](https://github.com/mkuczera/react-native-haptic-feedback/graphs/contributors)
@@ -29,22 +43,12 @@ Made with [contrib.rocks](https://contrib.rocks).
2943

3044
## Installation
3145

32-
**Stable (v2):**
33-
3446
```bash
3547
npm install react-native-haptic-feedback
3648
# or
3749
yarn add react-native-haptic-feedback
3850
```
3951

40-
**Pre-release (v3 — battle testing):**
41-
42-
```bash
43-
npm install react-native-haptic-feedback@next
44-
# or
45-
yarn add react-native-haptic-feedback@next
46-
```
47-
4852
React Native 0.71+ uses auto-linking — no extra steps needed.
4953

5054
---
@@ -427,6 +431,8 @@ import { TouchableHaptic } from "react-native-haptic-feedback";
427431
| `effectHeavyClick` | ✅ | ✅ | Android API 29+; iOS: Core Haptics approximation |
428432
| `effectTick` | ✅ | ✅ | Android API 29+; iOS: Core Haptics approximation |
429433
434+
> For the complete API reference including all types, options, and examples, see the [documentation site](https://mkuczera.github.io/react-native-haptic-feedback/api/).
435+
430436
---
431437
432438
## Platform internals
@@ -506,13 +512,14 @@ jest.mock("react-native-haptic-feedback");
506512
### Upgrade steps
507513
508514
```bash
509-
# Pre-release (recommended for testing)
510-
npm install react-native-haptic-feedback@next
515+
npm install react-native-haptic-feedback@latest
511516
cd ios && pod install
512517
```
513518
514519
All existing `trigger()` call-sites continue to work without changes. The new `confirm`, `reject`, `gestureStart/End`, `segmentTick/FrequentTick`, `toggleOn/Off` types are additive.
515520
521+
See the [full migration guide](https://mkuczera.github.io/react-native-haptic-feedback/guide/migration) in the docs.
522+
516523
---
517524
518525
## Acknowledgements

0 commit comments

Comments
 (0)