Make docs easier to read
DZuz14 opened this issue · comments
Docs are helpful, but should be split up into different sections, instead of one big promise. I can help out with a pull request for that if needed.
That would be really cool. There is an API reference here which are split out by function and generated with every new npm version, but I would like some more clarity in the Example Usage section of the main README. Since it's purpose is to give folks a quick sample of what it would look like to interact with the library it should be very nice to add clarity in that area.
Feel free to make some adjustments. I'm sure whatever you come up with would be awesome.
Also! If you want to add an additional example with an async/await function that would be cool too.
Dope salad. Will do. Hopefully get something whipped up over the weekend. Thanks for the new push feature.
I am still going to get on this. I actually had an interview yesterday that I have been studying the whole past week for, so had to put this on hold. However, I do have a new issue I am going to post here in a few minutes that I could use some help with.
Understanding that issue will make the docs more complete, as I am unsure how a few things still work.
Resolved by #33
Yoooo. I have no idea how to fix those formatting issues. So annoying. I tried deleting them and changing the tab spaces, and nothing. Any suggestions?
Mmmm, I'm not sure why it wouldn't let you. Might be something having to do with the editor you're using. I just pulled it up on my machine and used VSCode's "Convert Indentation to Tabs" option and it seemed to work.