Skip to content

Commit 9f8a6ca

Browse files
committed
Updates to main README
1 parent a729cd2 commit 9f8a6ca

File tree

1 file changed

+26
-13
lines changed

1 file changed

+26
-13
lines changed

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,39 @@
11
## PySTAC
2-
![Build Status](https://github.com/stac-utils/pystac/workflows/CI/badge.svg?branch=develop)
2+
![Build Status](https://github.com/stac-utils/pystac/workflows/CI/badge.svg?branch=main)
33
[![PyPI version](https://badge.fury.io/py/pystac.svg)](https://badge.fury.io/py/pystac)
44
[![Documentation](https://readthedocs.org/projects/pystac/badge/?version=latest)](https://pystac.readthedocs.io/en/latest/)
55
[![codecov](https://codecov.io/gh/stac-utils/pystac/branch/main/graph/badge.svg)](https://codecov.io/gh/stac-utils/pystac)
6-
[![Gitter chat](https://badges.gitter.im/azavea/pystac.svg)](https://gitter.im/azavea/pystac)
6+
77
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
88

99
PySTAC is a library for working with [SpatialTemporal Asset Catalog](https://stacspec.org) in Python 3.
1010

1111
## Installation
1212

13-
PySTAC has a single dependency (`python-dateutil`).
13+
PySTAC has a single required dependency (`python-dateutil`).
1414
PySTAC can be installed from pip or the source repository.
1515

1616
```bash
1717
> pip install pystac
1818
```
1919

20-
if you'd like to enable the validation feature utilizing the [jsonschema](https://pypi.org/project/jsonschema/) project, install with the optional `validation` requirements:
20+
If you would like to enable the validation feature utilizing the
21+
[jsonschema](https://pypi.org/project/jsonschema/) project, install with the optional
22+
`validation` requirements:
2123

2224

2325
```bash
2426
> pip install pystac[validation]
2527
```
2628

29+
If you would like to use the [`orjson`](https://pypi.org/project/orjson/) instead of the
30+
standard `json` library for JSON serialization/deserialization, install with the
31+
optional `orjson` requirements:
32+
33+
```bash
34+
> pip install pystac[orjson]
35+
```
36+
2737
From source repository:
2838

2939
```bash
@@ -34,28 +44,31 @@ From source repository:
3444

3545

3646
#### Versions
37-
To install a specific versions of STAC, install the matching version of pystac.
38-
39-
```bash
40-
> pip install pystac==0.5.*
41-
```
42-
43-
The table below shows the corresponding versions between pystac and STAC:
47+
To install a version of PySTAC that works with a specific versions of the STAC
48+
specification, install the matching version of PySTAC from the following table.
4449

45-
| pystac | STAC |
50+
| PySTAC | STAC |
4651
| ------ | ----- |
4752
| 1.x | 1.0.x |
4853
| 0.5.x | 1.0.0-beta.* |
4954
| 0.4.x | 0.9.x |
5055
| 0.3.x | 0.8.x |
5156

57+
For instance, to work with STAC v0.9.x:
58+
59+
```bash
60+
pip install pystac==0.4.0
61+
```
62+
63+
STAC spec versions below 0.8 are not supported by PySTAC.
64+
5265
## Documentation
5366

5467
See the [documentation page](https://pystac.readthedocs.io/en/latest/) for the latest docs.
5568

5669
## Developing
5770

58-
See [contributing docs](docs/contributing.rst)
71+
See [contributing docs](docs/contributing.rst) for details on contributing to this project.
5972

6073
## Running the quickstart and tutorials
6174

0 commit comments

Comments
 (0)