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

Clarify limitations of the library add add better usage examples to main readme #50

Open
vid553 opened this issue Oct 24, 2023 · 0 comments
Labels
type: documentation This is related to the documentation.

Comments

@vid553
Copy link

vid553 commented Oct 24, 2023

The main readme needs to be updated for easier usage.

Limitations I came across:

  • the ID's of the settings should not be changed when devices are already deployed (because the chip needs to be fully erased if the keys have been changed)
  • user_settings_load should be called before set defaults function

Also add function descriptions to the readme, so it is easier to see how the lib should be used (add setting the default, how to reset to defaults, etc).

@vid553 vid553 added the type: documentation This is related to the documentation. label Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation This is related to the documentation.
Projects
None yet
Development

No branches or pull requests

1 participant