faizalshap / react-native-otp-verify

React native sms verification without additional permissions
MIT License
253 stars 97 forks source link

Update README.md to Clarify SMS Message Hash Requirements #128

Open palmtown opened 2 days ago

palmtown commented 2 days ago

This PR updates the README.md to ensure absolute clarity regarding the SMS message format required for the OTP functionality. Specifically:

  1. Emphasizes that the SMS message must include the hash generated by the getHash() method.

  2. Explicitly states that the hash must be prepended with a # symbol for the functionality to work correctly.

  3. Adds examples and restructured the relevant section to make this requirement stand out, reducing the likelihood of it being overlooked by developers.

These changes aim to prevent common implementation errors related to missing or incorrectly formatted hashes in SMS messages.