Documentaion write up

[buabaj]

Is your feature request related to a problem? Please describe.
We need to write a code documentation for this package which clearly defines the purpose of the package, the installation process , usage(define the parameters and args it takes) and acknowledge all contributors.

[buabaj]

since the readme is perfectly well written, we're going to use that for the documentation. new ideas are welcome