Merge pull request #1 from StateLibraryVictoria/updated-doco

.github/workflows/deploy-to-hf-dev.yml

@@ -0,0 +1,22 @@
+name: Sync to dev Hugging Face hub
+on:
+  push:
+    branches-ignore:
+        - main
+
+  # to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          lfs: true
+      - name: Push to hub
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: git push https://HF_USERNAME:$HF_TOKEN@huggingface.co/spaces/sotirios-slv/theatre-programmer-dev main
+

.github/workflows/deploy-to-hf-prod.yml

@@ -1,4 +1,4 @@
-name: Sync to produciton Hugging Face hub
+name: Sync to production Hugging Face hub
 on:
   push:
     branches: [main]

README.md

@@ -1,7 +1,7 @@
 ---
 title: Theatre Programmer
-emoji: 🚀
-colorFrom: red
+emoji: 🍍
+colorFrom: blue
 colorTo: yellow
 sdk: gradio
 sdk_version: 4.7.1
@@ -17,7 +17,12 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
 Uses Tesseract to perform OCR on any image supplied as an input. The text identified in the image is then through a Flair Named Entity Recognition (NER) model, the output of which is returned to the page.
 
 This is a prototype produced for a project at the State Library Victoria in Melbourne, Australia.
-<!-- 
+
 ## Repository management
 
-Although Hugging Face is used to host the interactive demo of this app, GitHub is used to  -->
+Hugging Face is used to host two version of the demo app:
+
+1. the production version that is linked to the `main` branch of the GitHub repo
+2. a development version which is linked to the most recent branch pushed to GitHub that is **not** `main`
+
+Deployment to Hugging Face is done via GitHub actions.