From 7c73d160204591b37d3082ba18281ff0711636bb Mon Sep 17 00:00:00 2001
From: Daniel Santillan <daniel.santillan@eox.at>
Date: Thu, 7 Mar 2024 14:19:31 +0100
Subject: [PATCH] updated readme, updated build removing non working pages
 activation step

---
 .github/workflows/build_main.yaml | 10 ----------
 README.md                         | 16 ++++++++++++++++
 2 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/build_main.yaml b/.github/workflows/build_main.yaml
index b205674..d86d899 100644
--- a/.github/workflows/build_main.yaml
+++ b/.github/workflows/build_main.yaml
@@ -40,15 +40,5 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./build
           force_orphan: true
-      # Make sure github pages is enabled and set to gh-pages branch
-      - name: Update GitHub Pages source
-        run: |
-          curl -L \
-          -X POST \
-          -H "Accept: application/vnd.github+json" \
-          -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
-          -H "X-GitHub-Api-Version: 2022-11-28" \
-          "https://api.github.com/repos/${{ github.repository }}/pages" \
-          -d '{"source":{"branch":"main","path":"/"}}'
 
 
diff --git a/README.md b/README.md
index bad8825..f1c3e8a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
 # catalog-template
 Template for creating eodash catalog repository
+
+## How-to
+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.
+
+To make the build catalog available through github pages, please go to:
+ * repository settings
+   - Pages (left side panel)
+     - Source: "Deploy from branch" (should be selected)
+     - Branch: Select "gh-pages" from dropdown
+     - (leave root selected)
+     - Click on save
+
+Once enabled you can navigate to the catalog using:
+https://<organization>.github.io/<repository>/<catalog_name>/catalog.json