From 4e592dbe26356e051de831dd4784c04c0ab18105 Mon Sep 17 00:00:00 2001 From: fivecar <39933441+fivecar@users.noreply.github.com> Date: Tue, 5 Oct 2021 15:39:51 -0700 Subject: [PATCH] Update README to include pod install Also warn against calling any of the methods without checking `Platform.OS` first. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 7b702a4..48f7c91 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,15 @@ A very simple notification badge count manager for React Native that just works. Buy Me a Coffee at ko-fi.com +## Installation + +1. `npm install react-native-notification-badge` or `yarn add react-native-notification-badge` +2. `cd ios && pod install` + ## API +**Note: All APIs throw if `Platform.OS !== 'ios'`!**. So wrap your calls with a `Platform.OS` check first. + ### `getBadgeCount` **Asynchronously returns the current Badge count.**