Make Getting Started with the client a bit more clear

bttmly / nba

Node.js client for nba.com API endpoints

MIT License

708 stars 173 forks source link

Make Getting Started with the client a bit more clear #38

Closed scottdj92 closed 7 years ago

brandly commented 7 years ago

i like this! a small piece of example code would go a long way, i think - just something allowing you to copy, paste, run, and see that this thing works.

scottdj92 commented 7 years ago

I started using this client a few days ago, it was pretty confusing just trying to get started with it. After a while I finally got it, and thought "why isn't this in the readme?" so I made this PR

coveralls commented 7 years ago

Coverage remained the same at 79.554% when pulling 89dd43a6924b7ec0bce330c4f19cafd2e1d1d194 on scottdj92:master into 9c25cb6a55b5a8961fdbc983889ed30bfaac4750 on nickb1080:master.

bttmly commented 7 years ago

Thanks for the contribution! I cleaned this up a bit in https://github.com/nickb1080/nba/commit/7aa72cd6bef8a9c014392148286dc22db4817642 to ensure we pass the argument as an object, and used playerInfo because player stats doesn't actually take a player id (which is yeah kinda weird)

Any other tips on helping people to get started with this library are more than welcome!