v1.0.0 commit

Author: swar

README.md

@@ -0,0 +1,32 @@
+[![PyPi](https://img.shields.io/pypi/v/nba_api.svg?longCache=true&style=for-the-badge)](https://pypi.python.org/pypi/nba_api) [![PyPi](https://img.shields.io/pypi/l/nba_api.svg?longCache=true&style=for-the-badge)](https://pypi.python.org/pypi/nba_api)
+
+# nba_api
+
+`nba_api` is an API Client for `www.nba.com`. This package is meant to make the API Endpoints more accessible and to provide extensive documentation.
+
+The APIs on `www.nba.com` are largely undocumented and change ever so often.
+
+Please feel free to contribute and have an open discussion regarding improvements and additional APIs to be mapped.
+
+#### Mapped API Clients
+
+1. `stats.nba.com` - `stats`
+
+
+## Installation
+```commandline
+pip install nba_api
+```
+
+## Required and Optional Packages
+
+- [requests](http://www.python-requests.org/en/latest/)
+- [pandas](https://pandas.pydata.org/) `optional`
+
+## Documentation
+
+- [Table of Contents](docs/table_of_contents.md)
+    - [`stats.nba.com`](docs/nba_api/stats)
+    
+## Examples
+- [`stats.nba.com`](docs/nba_api/stats/examples.md)