Skip to content

Commit 6699c35

Browse files
committed
updates to readme and changelog for release 0.0.2
1 parent d6f295d commit 6699c35

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.0.2] - 2022-09-26
99

1010
### Added
1111

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,32 @@
2525

2626
STAC API Validator requires Python 3.10 and [Poetry 1.2](https://python-poetry.org/docs/).
2727

28-
Install the package with development requirements:
28+
You can install _STAC API Validator_ via [pip] from [PyPI]:
2929

3030
```console
31-
$ poetry install
31+
$ pip install stac-api-validator
3232
```
3333

34-
Note: if `poetry update` or `poetry install` hang, try running `poetry cache clear --all pypi` to fix the issue.
34+
and then run it:
3535

36-
You can now run the command-line interface:
36+
```console
37+
$ stac-api-validator \
38+
--root-url https://planetarycomputer.microsoft.com/api/stac/v1/ \
39+
--conformance core --conformance item-search
40+
```
41+
42+
To install from a clone of this repository for development, first install the package with development requirements:
3743

3844
```console
39-
$ poetry run stac-api-validator
45+
$ poetry install
4046
```
4147

42-
**Future Work** You can install _STAC API Validator_ via [pip] from [PyPI]:
48+
Note: if `poetry update` or `poetry install` hang, try running `poetry cache clear --all pypi` to fix the issue.
49+
50+
You can now run the command-line interface:
4351

4452
```console
45-
$ pip install stac-api-validator
53+
$ poetry run stac-api-validator
4654
```
4755

4856
## Usage
@@ -104,7 +112,7 @@ Options:
104112
Example:
105113

106114
```
107-
poetry run stac-api-validator \
115+
stac-api-validator \
108116
--root-url https://cmr.earthdata.nasa.gov/stac/LARC_ASDC \
109117
--conformance core --conformance item-search --conformance features
110118
```

0 commit comments

Comments
 (0)