Skip to content

Commit af35912

Browse files
updating README
1 parent 93fcec8 commit af35912

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
11
# stac-updater
2-
Keep your STAC catalog updated with SQS / SNS.
2+
CLI for building and deploying an AWS service designed to update and maintain STAC (via Lambda/SNS/SQS).
3+
4+
# Installation
5+
```
6+
git clone https://github.com/geospatial-jeff/stac-updater
7+
cd stac-updater
8+
python setup.py develop
9+
```
10+
11+
# Usage
12+
Use the [stac-updater CLI](stac_updater/cli.py) to build and deploy your service. Updating a static collection, for example, is accomplished as follows:
13+
14+
```
15+
# Start a new service
16+
stac-updater new-service
17+
18+
# Build AWS resources to update collection
19+
stac-updater update-collection --name landsat-8-l1 --root https://stac.com/landsat-8-l1/catalog.json
20+
21+
# Modify kickoff event source to s3:ObjectCreated
22+
stac-updater modify-kickoff --type s3 --bucket_name stac-updater-kickoff
23+
24+
# Deploy the service to AWS
25+
stac-updater deploy
26+
```
27+
28+
Once deployed, any STAC Item uploaded to the `stac-updater-kickoff` bucket will be ingested by the service and added to the `https://stac.com/landsat-8-l1/catalog.json` collection.

0 commit comments

Comments
 (0)