Skip to content

Commit b87496c

Browse files
committed
Cleaned up README.md
1 parent 4297515 commit b87496c

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# RuleKit
22

3-
TipKit style API to trigger foundation notification based on events and condition.
3+
TipKit style API to trigger an arbitrary closure, or a NSNotification based on events and condition.
44

55
## Usecases
66
- To open your Paywall from time to time
77
- To prompt your user to add an App Store review
88
- Watching and sending achievements to Game Center with GameKit
9+
- Show a shortcut available for an action that is often performed by a user
910
- ...
1011

1112
## Requirements
@@ -31,9 +32,10 @@ And import it:
3132
import RuleKit
3233
```
3334

35+
3436
## How to use?
3537

36-
RuleKit is about one thing: invoking a foundation notification when a set of rules are fulfilled!
38+
RuleKit is about one thing: invoking a closure, or trigger a NSNotification when a set of rules are fulfilled!
3739

3840
- Configure RuleKit when your application starts
3941
```swift
@@ -73,7 +75,7 @@ struct ContentView: View {
7375
}
7476
}
7577
```
76-
- Register your business rules that will trigger the notification
78+
- Register your business rules that should trigger your closure, or your notification
7779
```swift
7880
RuleKit.setRule(
7981
triggering: requestReviewNotification,
@@ -98,7 +100,7 @@ RuleKit.setRule(
98100
])
99101
)
100102
```
101-
- Donate those event at proper places in your app
103+
- Donate those events at proper places in your app
102104
```swift
103105
// Asynchronously
104106
RuleKit.Event.appStarted.sendDonation()

0 commit comments

Comments
 (0)