Add documentation for the public API

[jzheng2017]

Currently there are only few example usages in the README.md that explains how to use the library.

It would be great if there was documentation explaining each function that is provided by the library.

Documentation should contain:

• Function syntax (return value, parameters, etc)
• Function description
• Function example usage (code example)

[ievalu]

Hi,

I'd like to contribute to the documentation part of this project!
I see you labeled this as epic, do you have an idea how to split up this issue into smaller tasks already?

[jzheng2017]

Hi @ievalu, thank you for taking an interest. No, I haven't had the time to work out the issues further in detail. I've been pretty busy with school.

But the general plan is to have a GitHub wiki where all the documentation should be.

I'll give an update in the coming weeks/months (probably months, I'm starting my internship pretty soon so I'll be busy with that).

[ievalu]

All right!

Then I probably won't start anything by myself.

Thank you for the update!

[SiddhiChavan08]

I am siddhi,
final year IT student. I would like to contribute for this issue.
Could You assign me this task ?
Thanks