From ddf17aecca8dcb16158de103200941cd75b67992 Mon Sep 17 00:00:00 2001
From: ikoamu <ikoamu@gmail.com>
Date: Wed, 24 Jan 2024 23:37:22 +0900
Subject: Add instructions for generating static org-roam-ui page

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 9d35dab..242606a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,37 @@
 # org-roam-ui-hosting
 
 This action generates a static site for [org-roam-ui](https://github.com/org-roam/org-roam-ui) from [org-roam](https://www.orgroam.com/) files managed on GitHub.
+
 It also allows deployment to GitHub Pages.
+
+## How to Use
+
+First, please manage the .org files in `org-roam-directory` and the db file in org-roam using git.
+
+```lisp
+(setq org-roam-directory "/path/to/org-roam-dir")
+(setq org-roam-db-location "/path/to/org-roam-dir/<org-roam-filename>.db")
+```
+
+```bash
+cd /path/to/org-roam-dir/
+git init
+```
+
+Then, a static org-roam-ui site is easily generated for the artifact by creating a workflow like the following.
+
+```yml
+name: Generate static org-roam-ui page
+on:
+  push:
+    branches:
+      - main
+jobs:
+  generate:
+    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
+```
-- 
cgit