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

Add code examples for basic operations in README.md #18

Open
4 tasks
rtb-12 opened this issue Dec 16, 2024 · 0 comments
Open
4 tasks

Add code examples for basic operations in README.md #18

rtb-12 opened this issue Dec 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation easy This easy solve this if you are a beginner!

Comments

@rtb-12
Copy link
Collaborator

rtb-12 commented Dec 16, 2024

We need to enhance the project's README.md file by including simple primitive methods like Read,Write,Keys,Erase,Put examples for basic operations. This will make it easier for new users and contributors to understand and utilize the project.

Tasks

  • Add a Read Example to the README.
  • Add a Write Example to the README.
  • Add a Delete Example to the README.
  • Add a Keys Listing Example to the README.

Additional Notes

  • Ensure examples are concise and beginner-friendly.
  • Use comments in the code snippets to explain each step.
  • Validate the examples to confirm they work with the current implementation of the project. Add them to an examples directory
@0xnullifier 0xnullifier added documentation Improvements or additions to documentation easy This easy solve this if you are a beginner! labels Dec 16, 2024
IshaanXCoder added a commit to IshaanXCoder/Memoria that referenced this issue Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation easy This easy solve this if you are a beginner!
Projects
None yet
Development

No branches or pull requests

2 participants