matheus-rodrigues00 / utils

✨ Library to commonly used cross-projects utilities methods ✨
17 stars 11 forks source link

Docs Improvement: README.md #15

Closed matheus-rodrigues00 closed 1 year ago

matheus-rodrigues00 commented 1 year ago

Create tables for each utility type. Containing it's name, the description of what it does, the arguments and the return. Like:

randomizeArray | This method recieves an array and returns a randomized version of it. | randomizeArray(array: any[]) | returns {Array}

How we specify the arguments and return type can be improved, just didn't figured anything better rn.