documentation of this project

[daveclinton]

What feature are you adding?

Add indepth documentation of this project

Describe your issue

I am looking to contribute a good documentation practice here:

• THE README.md file: Make it informative, make it brief, make it incentive enough for them to keep on digging through all the other docs in your documentation, as well.

• THE REFERENCE FILE: all the functions in your software and how they work what inputs and outputs its users should expect … and side effects, too your project's main goal(s)

• THE GUIDE FILE : A tutorial-like document that “takes the user by the hand” and loops through all the features of your software.

[orama254]

Hello @daveclinton

Do you have an example of the presented suggestions that we can look at?

[daveclinton]

Sure, I'll share in a few.