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

Documentation #11

Open
1 of 5 tasks
sooraj1002 opened this issue Apr 6, 2024 · 0 comments
Open
1 of 5 tasks

Documentation #11

sooraj1002 opened this issue Apr 6, 2024 · 0 comments

Comments

@sooraj1002
Copy link
Collaborator

sooraj1002 commented Apr 6, 2024

TODO:

  • Create a docs folder.
  • Add descriptive comments for each of the exported functions
  • Add an example folder
  • Document the JSON spec extensively.
  • Update the README to include the available options, expected outputs, etc
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

2 participants