Merge pull request #63 from jonhealy1/dev

Update readme, v1.1.0

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v1.0.1] - 2022-02-20
+- Update readme
+
+## [v1.0.0] - 2022-02-20
+### Changed
+- Reorganized code for version 1.0.0 release
+
 ## [v0.2.0] - 2022-02-02 - 2022-02-19
 ### Added
 - Import main validator as stac-validator was updated to 2.3.0

README.md

@@ -1,9 +1,37 @@
 # stac-check
-## Linting and validation tool for STAC assets
+## A linting and validation tool for STAC assets
 
-This project is a work in progress. The intent is to provide a validation tool that also follows the official STAC Best Practices document: https://github.com/radiantearth/stac-spec/blob/master/best-practices.md
-
-``` pip install -e . ```    
+The intent of this project is to provide a validation tool that also follows the official STAC Best Practices document: https://github.com/radiantearth/stac-spec/blob/master/best-practices.md   
+
+---
+### Install
+`$ pip install stac-check`   
+
+or for local development   
+
+`$ pip install -e .` 
+
+---
+### Usage
+```
+Usage: stac_check [OPTIONS] FILE
+
+Options:
+  --version        Show the version and exit.
+  -l, --links      Validate links for format and response.
+  -a, --assets     Validate assets for format and response.
+  -r, --recursive  Validate all assets in a collection or catalog.
+  --help           Show this message and exit.
+```
+---
+### Docker  
+
+```
+$ make build  
+$ make shell
+```
+---
+### Examples
 
 ``` stac_check https://raw.githubusercontent.com/stac-utils/pystac/main/tests/data-files/examples/0.9.0/collection-spec/examples/landsat-collection.json --recursive ```
 ```

setup.py

@@ -2,7 +2,7 @@
 """
 from setuptools import setup, find_packages
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 
 with open("README.md", "r") as fh:
     long_description = fh.read()