Skip to content

docs: fix typos in README.MD #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix typos in README.MD #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ The Google Play In-App Review API, App Store rating API let you prompt users to
react-native in-app-review, to rate on Play Store, and App Store, Generally, the in-app review flow (see figure 1 for Play Store, figure 2 for ios) can be triggered at any time throughout the user journey of your app. During the flow, the user has the ability to rate your app using the 1 to 5-star system and to add an optional comment for Play Store only. Once submitted, the review is sent to the Play Store or App Store and eventually displayed.

## Would you like to support me?

If you want to help me cheer up, I'm always looking for freelance tasks or a #part-time job, D.M on LinkedIn.

If you would like to help me cheer up, buying me a cup of coffee will make my life really happy and give me a lot of energy.
<a href="https://www.buymeacoffee.com/MinaSamir" target="_blank">
<img
<img
src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"
alt="Buy Me A Coffee"
width="200px"
Expand Down Expand Up @@ -73,7 +74,7 @@ yarn upgrade

## (A1.1)After you finished from sign-up in npm.paydevs, Go to [PayDevs, react-native-in-app-review](https://npm.paydevs.com/-/web/detail/react-native-in-app-review) to complete the package installation steps.

## (B1) Normal Installation (Free User), (latest version will be avaliable on the public registry after 10 days from releasing on PayDevs).
## (B1) Normal Installation (Free User), (latest version will be available on the public registry after 10 days from releasing on PayDevs).

```sh
$ npm install react-native-in-app-review
Expand Down Expand Up @@ -190,15 +191,15 @@ InAppReview.RequestInAppReview()
// when return true in android it means user finished or close review flow
console.log('InAppReview in android', hasFlowFinishedSuccessfully);

// when return true in ios it means review flow lanuched to user.
// when return true in ios it means review flow launched to user.
console.log(
'InAppReview in ios has launched successfully',
hasFlowFinishedSuccessfully,
);

// 1- you have option to do something ex: (navigate Home page) (in android).
// 2- you have option to do something,
// ex: (save date today to lanuch InAppReview after 15 days) (in android and ios).
// ex: (save date today to launch InAppReview after 15 days) (in android and ios).

// 3- another option:
if (hasFlowFinishedSuccessfully) {
Expand All @@ -212,13 +213,13 @@ InAppReview.RequestInAppReview()
// matter the result, we continue our app flow.

// for ios
// the flow lanuched successfully, The API does not indicate whether the user
// the flow launched successfully, The API does not indicate whether the user
// reviewed or not, or he/she closed flow yet as android, Thus, no
// matter the result, we continue our app flow.
})
.catch((error) => {
//we continue our app flow.
// we have some error could happen while lanuching InAppReview,
// we have some error could happen while launching InAppReview,
// Check table for errors and code number that can return in catch.
console.log(error);
});
Expand All @@ -241,7 +242,7 @@ InAppReview.requestInAppCommentAppGallery()
})
.catch((error) => {
//we continue our app flow.
// we have some error could happen while lanuching in app comment,
// we have some error could happen while launching in app comment,
// Check table for errors appears in app gallery and code number that can return in catch.
console.log(error);
});
Expand Down Expand Up @@ -270,11 +271,11 @@ InAppReview.requestInAppCommentAppGallery()
| The user canceled the comment. | 108 | The user canceled the comment. | ✅ |
| in app comment Unknown error | 0 | Unknown Error | ✅ |

# + Android guidlelines and notes:
# + Android guidelines and notes:

# Read very well for (Google Play):

After publishing you app to test your integration in production or either internal test tracks or internal app sharing and prompt in app review flow you may face issue that not showing review popup after you followed all guidelines very well,
After publishing your app to test your integration in production or either internal test tracks or internal app sharing and prompt in app review flow you may face issue that not showing review popup after you followed all guidelines very well,
**Note that this issue was classified as google play api issue.**

We found most probably solutions that may be successful to launch review popup:
Expand All @@ -285,7 +286,7 @@ We found most probably solutions that may be successful to launch review popup:
- Please note, that user must be a tester if you are testing on any testing track.
- CLEAR CACHE and CLEAR STORAGE from Google Play Store app.
- Remove existing app rating in Google Play Store.
- after doing all of pervious solutions, remove your app and reinstall it.
- after doing all of previous solutions, remove your app and reinstall it.

# When to request an in-app review

Expand Down