Skip to content

Commit

Permalink
README changes and removing index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
swar committed Sep 26, 2018
1 parent fd78110 commit 135b42d
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 9 deletions.
40 changes: 34 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

`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.
The APIs on `www.nba.com` are largely undocumented and changes frequently.

Please feel free to contribute and have an open discussion regarding improvements and additional APIs to be mapped.

Expand All @@ -25,10 +25,38 @@ pip install nba_api
- [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
## Usage Examples
- [`stats.nba.com`](docs/nba_api/stats/examples.md)


## Documentation

- [Table of Contents](table_of_contents.md)

- [Package Structure](package_structure.md)

- [Endpoint Analysis Format](endpoint_analysis_format.md)

- [Scripts](scripts.md)

- NBA API
- Library
- Debug
- [debug.py](nba_api/debug.md)
- [http.py](nba_api/library/http.md)
- Tools
- [Endpoint Analysis](nba_api/tools/stats/endpoint_analysis/analysis.md)
- [Endpoint Documentation Generator](nba_api/tools/stats/endpoint_documentation_generator/generator.md)
- [Endpoint Py File Generator](nba_api/tools/stats/endpoint_py_file_generator/generator.md)
- [Parameter Documentation Generator](nba_api/tools/stats/parameter_documentation_generator/generator.md)
- Stats [`stats.nba.com`](nba_api/stats/endpoints)
- [Examples](nba_api/stats/examples.md)
- Library
- [data.py](nba_api/stats/library/data.md)
- [http.py](nba_api/stats/library/http.md)
- [parameters.py](nba_api/stats/library/parameters.md)
- Static
- [players.py](nba_api/stats/static/players.md)
- [teams.py](nba_api/stats/static/teams.md)
- [Endpoints](nba_api/stats/endpoints_data_structure.md)
1 change: 0 additions & 1 deletion docs/index.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/table_of_contents.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Table of Contents

- [Index](index.md)

- [Table of Contents](table_of_contents.md)

- [Package Structure](package_structure.md)
Expand Down

0 comments on commit 135b42d

Please sign in to comment.