Skip to content
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.

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

Improve README for Registering/Deregistering Phone Numbers and Looking Up Phone Numbers #25

Open
Suvadra-Barua opened this issue Feb 27, 2024 · 0 comments

Comments

@Suvadra-Barua
Copy link

Obtaining information from the README is straightforward for developers familiar with minipay/social-connect. However, for newcomers seeking clarity on the process of registering/deregistering phone numbers and looking up phone numbers, understanding the context can be challenging without thoroughly reviewing the entire codebase or consulting a contributing developer.

For example, before attempting to look up a phone number, developers should register as an issuer and DEK, ensure they have cUSD for making requests to ODIS (transforming plaintext identifiers to obfuscated identifiers), and understand limitations such as the maximum number of addresses that can be looked up per cUSD.

These steps are currently undocumented here. If they have been properly documented elsewhere, they should be included in this README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant