From b903d93cd508c9526731a2ac120e3a34cbe6567e Mon Sep 17 00:00:00 2001 From: Francis Charette Migneault Date: Mon, 18 Dec 2023 13:00:14 -0500 Subject: [PATCH] add readme table impl details --- CHANGES.md | 2 +- README.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 3910ea1..9bae0f7 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -2,7 +2,7 @@ ## [Unreleased](https://github.com/crim-ca/stac-populator) (latest) - +* Update README with a table providing missing `DirectoryLoader` implementation and adding `CMIP6_UofT` description. ## [0.4.0](https://github.com/crim-ca/stac-populator/tree/0.4.0) (2023-11-27) diff --git a/README.md b/README.md index a764124..ca342b5 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,13 @@ contain all the logic for constructing the STAC representation for an item in th Provided implementations of `STACpopulatorBase`: -- [CMIP6_UofT][CMIP6_UofT] +| Implementation | Description | +|--------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| [CMIP6_UofT][CMIP6_UofT] | Crawls a THREDDS Catalog for CMIP6 NCML-annotated NetCDF references to publish corresponding STAC Collection and Items. | +| [DirectoryLoader][DirLoader] | Crawls a subdirectory hierarchy of pre-generated STAC Collections and Items to publish to a STAC API endpoint. | [CMIP6_UofT]: STACpopulator/implementations/CMIP6_UofT/add_CMIP6.py +[DirLoader]: STACpopulator/implementations/DirectoryLoader/crawl_directory.py ## Installation and Execution