aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 242606a..c048f0d 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ on:
branches:
- main
jobs:
- generate:
+ main:
runs-on: ubuntu-latest
steps:
- name: Generate org-roam-ui page
@@ -35,3 +35,19 @@ jobs:
with:
org-roam-db-filename: <org-roam-filename>.db
```
+
+<img width="669" alt="generated artifact" src="https://github.com/ikoamu/publish-org-roam-ui/assets/38206334/fdc9f133-c97c-4d3b-b328-3a1d86560e83">
+
+Deploy to GitHub Pages by setting `deploy-to-pages` to true.
+
+```yml
+jobs:
+ main:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Generate org-roam-ui page
+ uses: ikoamu/org-roam-ui-hosting@main
+ with:
+ org-roam-db-filename: <org-roam-filename>.db
+ deploy-to-pages: true
+```