docs: mention that getPhoneNumber() may return undefined

Closes #327
react-native-device-info · Feb 23, 2018 · aab3ad6 · aab3ad6
1 parent 5daad48
commit aab3ad6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -569,6 +569,10 @@ const phoneNumber = DeviceInfo.getPhoneNumber();
 
 * [android.permission.READ_PHONE_STATE](https://developer.android.com/reference/android/Manifest.permission.html#READ_PHONE_STATE)
 
+**Notes**
+
+> This can return `undefined` in certain cases and should not be relied on. [SO entry on the subject](https://stackoverflow.com/questions/2480288/programmatically-obtain-the-phone-number-of-the-android-phone#answer-2480307).
+
 ---
 
 ### getReadableVersion()