From d5159ea05e339d0af4e8cd417cbc818ca2e4eacd Mon Sep 17 00:00:00 2001
From: janf <ioan.ferencik@solargis.com>
Date: Tue, 28 Nov 2023 19:48:52 +0100
Subject: [PATCH] added docs about realeasing

---
 .github/workflows/build_and_deploy.yml | 11 +++---
 README.md                              | 47 +++++++++++++++++++++++++-
 2 files changed, 52 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml
index d1aed64..f2847b8 100644
--- a/.github/workflows/build_and_deploy.yml
+++ b/.github/workflows/build_and_deploy.yml
@@ -44,11 +44,11 @@ jobs:
 
           labels: ${{ steps.meta.outputs.labels }}
 
-      - name: Dump tags
-        run: | 
-          echo "${{ steps.meta.outputs.tags }}"
-          echo "${{ github.ref_name }}"
-          echo "Tag is proper ${{ contains(steps.meta.outputs.tags, ':v') }}"
+#      - name: Dump tags
+#        run: |
+#          echo "${{ steps.meta.outputs.tags }}"
+#          echo "${{ github.ref_name }}"
+#          echo "Tag is proper ${{ contains(steps.meta.outputs.tags, ':v') }}"
 
       - name: Create release
         if: ${{ contains(steps.meta.outputs.tags, ':v') }}
@@ -59,3 +59,4 @@ jobs:
         with:
           tag: ${{ github.ref_name  }}
           generateReleaseNotes: true
+          draft: false
\ No newline at end of file
diff --git a/README.md b/README.md
index 30dbba3..5013286 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
-# geo-cogserver
+# Geohub's COGserver
 GeoHub COG server is powering UNDP GeoHub visualization of raster datasets
+
+COG server builds on [titiler](https://github.com/developmentseed/titiler) a customisable dynamic raster tiling.
+It contains following components:
+
+- [x] COG tiler - render tiles from COG's
+  - [x] create STAC item from COG
+- [x] MosaicJSON tiler - create/render MosaicJSON docs 
+- [x] STAC tiler - render STAC items
+- [ ] Multiband tiler - render heterogenous COGs 
+
+Additionally, **COG server** aims to hold generic and specific [titiler algos](https://devseed.com/titiler/advanced/Algorithms/)
+intended to provide a geospatial analytics toolbox
+
+# versioning & realeases
+
+As per [titiler's](https://github.com/developmentseed/titiler) recommendation
+COGserver employs the titiler's API to build a customised server and keeps its own versioning
+system.
+
+Releases ca be created by:
+
+a) pushing tags
+   1. commit your changes in a branch 
+       ```bash
+            git checkout -b branch_name
+            git add .
+            git commit -m "a message"
+            
+       ```
+   2. make and merge the branch through a PR
+   3. create a local tag and push it to remote
+       ```bash
+          git tag -a v0.0.1 -m "v0.0.1"
+          git push --tag
+       ```
+   4. potentially delete/overwrite 
+       ```bash
+          git push --delete origin v0.0.1 #remote
+          git tag -d v0.0.1 #local
+       ```
+b) creating a release manually using Github
+
+
+
+