Github
/
nhlapi
mirror of https://gitlab.com/dword4/nhlapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md to be a little bit better

This commit is contained in:
Drew Hynes 2020-02-20 16:30:02 +00:00
parent bd4b3333e4
commit 747d8c423e
1 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,10 +1,31 @@
# NHL API Documentation
---
In light of the recent addition of records.nhl.com and the effort to document
the API that it relies upon it became necessary to split up the files for sanity
sake.
## About this Project
This effort is purely to make it easier for stats nerds and the like to make
use of the wonderful trove of information the NHL provides to us but in a much
more digestible form. I am only one person so if you see something I have missed
please feel free to open up a PR and I will get it merged.
more digestible form.
## Roadmap
Eventually build documentation on features such as cayenneExp which allows for
retrieval of very complex documentation and perhaps even a more thorough set of
documentation including examples in multiple common langages (such as using Swagger)
## Contributing
I am only one person so if you see something I have missed please feel free to
open up a MR/PR and I will get it merged. Generally speaking I get things done
in a few days as time permits between work and other obligations.
## Contact
Generally I am reached via Twitter [@dw0rd4](https://twitter.com/dw0rd4)
## Acknowledgements
[Kevin Sidwar](https://www.kevinsidwar.com/) - First real source of documentation I found on the API and gave me
a nice starting point for a project that eventually evolved into this repository
[Jon Ursenbach](https://github.com/erunion) - Built out an [OpenAPI 3 spec](https://github.com/erunion/sport-api-specifications) for the NHL API