BloomTech-Labs / betterreads-ds

MIT License

1 stars 3 forks source link

README update with API documentation #12

Closed mvkumar14 closed 4 years ago

mvkumar14 commented 4 years ago

Description

README update with API documentation

Type of change

Please delete options that are not relevant.

[x] Documentation update

Change Status

[x] Complete, tested, ready to review and merge
[ ] Complete, but not tested (may need new tests)
[ ] Incomplete/work-in-progress, PR is for discussion/feedback

Checklist

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] My code has been reviewed by at least one peer
[ ] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[x] There are no merge conflicts