Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WorldDownTown committed Apr 10, 2017
1 parent 57d8078 commit 0af11fe
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
TapticEngine generates haptic feedback vibrations on iOS device.
This library wrapps on [UIImpactFeedbackGenerator](https://developer.apple.com/reference/uikit/uiimpactfeedbackgenerator), [UISelectionFeedbackGenerator](https://developer.apple.com/reference/uikit/uiselectionfeedbackgenerator), [UINotificationFeedbackGenerator](https://developer.apple.com/reference/uikit/uinotificationfeedbackgenerator).

<img src="https://raw.githubusercontent.com/WorldDownTown/TapticEngine/master/taptic_engine.png" alt="demo_screenshot" width="375px" />
<img src="https://raw.githubusercontent.com/WorldDownTown/TapticEngine/master/images/taptic_engine.png" alt="demo_screenshot" width="375px" />

## Demo
Build Xcode project.
Expand Down Expand Up @@ -42,6 +42,15 @@ TapticEngine.notification.feedback(.warning)

// Triggers a notification feedback, indicating that a task has failed. (`UINotificationFeedbackType.error`)
TapticEngine.notification.feedback(.error)

// Prepare a impact feedback for `UIImpactFeedbackStyle.light`.
TapticEngine.impact.prepare(.light)

// Prepare a selection feedback.
TapticEngine.selection.prepare()

// Prepare a notification feedback.
TapticEngine.notification.prepare()
```

## Requirements
Expand Down
2 changes: 1 addition & 1 deletion TapticEngine.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Pod::Spec.new do |s|
This library wrapps on [UIImpactFeedbackGenerator](https://developer.apple.com/reference/uikit/uiimpactfeedbackgenerator), [UISelectionFeedbackGenerator](https://developer.apple.com/reference/uikit/uiselectionfeedbackgenerator), [UINotificationFeedbackGenerator](https://developer.apple.com/reference/uikit/uinotificationfeedbackgenerator).
DESC
s.homepage = 'https://github.com/WorldDownTown/TapticEngine'
s.screenshots = 'https://dl2.pushbulletusercontent.com/TKSfPYAu8pl5NARwARj2E3j87llwnXcs/taptic_engine.png'
s.screenshots = 'https://raw.githubusercontent.com/WorldDownTown/TapticEngine/master/images/taptic_engine.png'
s.license = { type: 'MIT', file: 'LICENSE' }
s.author = { WorldDownTown: 'WorldDownTown@gmail.com' }
s.source = { git: 'https://github.com/WorldDownTown/TapticEngine.git', tag: s.version.to_s }
Expand Down

0 comments on commit 0af11fe

Please sign in to comment.