Skip to content

Added Table of Contents to ReadMe #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2022
Merged

Added Table of Contents to ReadMe #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ STAC Client

A Python client for working with [STAC](https://stacspec.org/) Catalogs and APIs.

## Table of Contents

- [Installation](#installation)
- [Documentation](#documentation)
- [Development](#development)
- [Pull Requests](#pull-requests)

## Installation

Install from PyPi. Other than [PySTAC](https://pystac.readthedocs.io) itself, the only dependencies for pystac-client is the Python [requests](https://docs.python-requests.org) and [dateutil](https://dateutil.readthedocs.io) libraries.
Expand Down Expand Up @@ -42,7 +49,7 @@ $ pytest -v -s --block-network --cov pystac_client --cov-report term-missing

The pystac-client tests use [vcrpy](https://vcrpy.readthedocs.io/en/latest/) to mock API calls
with "pre-recorded" API responses. When adding new tests use the `@pytest.mark.vcr` decorator
function to indicate `vcrpy` should be used. Record the new responses and commit them to the
function to indicate `vcrpy` should be used. Record the new responses and commit them to the
repository.

```shell
Expand All @@ -61,7 +68,7 @@ $ git commit -a -m 'updated test episodes'

### Pull Requests

To make Pull Requests to pystac-client, the code must pass linting, formatting, and code tests. To run
To make Pull Requests to pystac-client, the code must pass linting, formatting, and code tests. To run
the entire suit of checks and tests that will be run the GitHub Action Pipeline, use the `test` script.

```shell
Expand Down