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

API documentation and usage examples #13

Open
curtwagner1984 opened this issue Dec 27, 2021 · 0 comments
Open

API documentation and usage examples #13

curtwagner1984 opened this issue Dec 27, 2021 · 0 comments

Comments

@curtwagner1984
Copy link

While this is an internal library, it would be nice to have some sort of API documentation that details what the library can do and what API endpoints should be used to achieve its functionality.

Something like a short 'Getting Started' guide that gives a basic usage example and basic API documentation that tells arguments and outputs are expected to the core API entry points.

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