Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
santilland authored Mar 7, 2024
1 parent 7c73d16 commit 5e03526
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ You can create a new repository using the "use this template" button.
This will set-up a catalog repository for you with example configuration files as well as a github workflow that will automatically build and deploy the STAC catalog to the gh-page branch.
For every commit you push to the main branch the catalog will be regenerated and deployed there.

Please consider! This deployment strategy is intended for reasonable sized catalogs, if a catalog gets larger a more robust strategy should be implemented, changing the current github action, for example deploying the build to an s3 bucket.

To make the build catalog available through github pages, please go to:
* repository settings
- Pages (left side panel)
Expand All @@ -15,4 +17,5 @@ To make the build catalog available through github pages, please go to:
- Click on save

Once enabled you can navigate to the catalog using:
https://<organization>.github.io/<repository>/<catalog_name>/catalog.json

https://\<organization\>.github.io/\<repository\>/\<catalog_name\>/catalog.json

0 comments on commit 5e03526

Please sign in to comment.