Skip to content

Commit

Permalink
Merge pull request #5 from nventive/dev/wihu/update-readme-links
Browse files Browse the repository at this point in the history
docs: update readme links
  • Loading branch information
Ouillyang authored Nov 20, 2024
2 parents 56647f0 + b31b218 commit 0c8bc17
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 20 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)

## 0.4.0

- Ported the code from the .NET version of the package to dart.
- Ported the code from the .NET version of the package to dart.

## 0.4.1

- Updated hyperlinks in README.md
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,19 +100,17 @@ Now that everything is setup, Let's see what else we can do!
To track the provided review settings you can use the following `ReviewService` extensions.
> 💡 The review request count and the last review request are automatically tracked by the service.
TODO: Change the github links to the dart package once merged
- [TrackApplicationLaunched](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewService.Extensions.cs#L20) : Tracks that the application was launched (Also tracks if it's the first launch).
- [TrackPrimaryActionCompleted](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewService.Extensions.cs#L45) : Tracks that a primary action was completed.
- [TrackSecondaryActionCompleted](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewService.Extensions.cs#L61) : Tracks that a secondary action was completed.
- [TrackApplicationLaunched](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_service.extensions.dart#L8) : Tracks that the application was launched (Also tracks if it's the first launch).
- [TrackPrimaryActionCompleted](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_service.extensions.dart#L22) : Tracks that a primary action was completed.
- [TrackSecondaryActionCompleted](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_service.extensions.dart#L29) : Tracks that a secondary action was completed.

#### Built-in Tracking Data
TODO: Change the github links to the dart package once merged
- [PrimaryActionCompletedCount](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewSettings.cs#L13) : The number of primary actions completed.
- [SecondaryActionCompletedCount](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewSettings.cs#L18) : The number of secondary actions completed.
- [ApplicationLaunchCount](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewSettings.cs#L23) : The number of times the application has been launched.
- [FirstApplicationLaunch](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewSettings.cs#L28) : When the application first started.
- [RequestCount](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewSettings.cs#L33) : The number of review requested.
- [LastRequest](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewSettings.cs#L38) : When the last review was requested.
- [PrimaryActionCompletedCount](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_settings.dart#L4) : The number of primary actions completed.
- [SecondaryActionCompletedCount](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_settings.dart#L7) : The number of secondary actions completed.
- [ApplicationLaunchCount](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_settings.dart#L10) : The number of times the application has been launched.
- [FirstApplicationLaunch](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_settings.dart#L13) : When the application first started.
- [RequestCount](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_settings.dart#L16) : The number of review requested.
- [LastRequest](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_settings.dart#L19) : When the last review was requested.

### Configure Conditions

Expand All @@ -125,14 +123,13 @@ The `ReviewConditionsBuilder.Default()` extension method uses the following cond
- **15** days since the last review request.

#### Built-in Conditions
TODO: Change the github links to the dart package once merged
- [MinimumPrimaryActionsCompleted](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L17) : Make sure that it prompts for review only if the number of completed primary actions meets the minimum.
- [MinimumSecondaryActionsCompleted](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L33) : Make sure that it prompts for review only if the number of completed secondary actions meets the minimum.
- [MinimumApplicationLaunchCount](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L49) : Make sure that it prompts for review only if the number of times the application has been launched meets the required minimum.
- [MinimumElapsedTimeSinceApplicationFirstLaunch](https://github.com/nventive/ReviewService/blob/a78e37c7e9b6fbe07ba1fec5d0f2b3b2f31bf356/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L65) : Make sure that it prompts for review only if the elapsed time since the first application launch meets the required minimum.
- [MinimumElapsedTimeSinceLastReviewRequest](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L83) : Make sure that it prompts for review only if the elapsed time since the last review request meets the required minimum.
- [Custom](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L99) : Custom condition made with a synchronous lambda function.
- [CustomAsync](https://github.com/nventive/ReviewService/blob/1484f946c60e2bf1cb86b27faa60c148a1e56d45/src/ReviewService.Abstractions/ReviewConditionsBuilder.Extensions.cs#L113) : Custom asynchronous condition made with an asynchronous lambda function.
- [MinimumPrimaryActionsCompleted](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L12) : Make sure that it prompts for review only if the number of completed primary actions meets the minimum.
- [MinimumSecondaryActionsCompleted](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L20) : Make sure that it prompts for review only if the number of completed secondary actions meets the minimum.
- [MinimumApplicationLaunchCount](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L28) : Make sure that it prompts for review only if the number of times the application has been launched meets the required minimum.
- [MinimumElapsedTimeSinceApplicationFirstLaunch](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L36) : Make sure that it prompts for review only if the elapsed time since the first application launch meets the required minimum.
- [MinimumElapsedTimeSinceLastReviewRequest](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L45) : Make sure that it prompts for review only if the elapsed time since the last review request meets the required minimum.
- [Custom](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L54) : Custom condition made with a synchronous lambda function.
- [CustomAsync](https://github.com/nventive/ReviewService-Dart/blob/56647f03e9625c534e5731a2bc3bd067088652e1/lib/src/review_service/review_conditions_builder.extensions.dart#L60) : Custom asynchronous condition made with an asynchronous lambda function.

### Add Custom Conditions

Expand Down

0 comments on commit 0c8bc17

Please sign in to comment.