diff --git a/README.md b/README.md index 5bd04fd..20379cf 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file