From 4ddbeb48abf31e7a0e4472025611f07910ec2334 Mon Sep 17 00:00:00 2001
From: Bruno Tot <brunotot10000@gmail.com>
Date: Wed, 17 Apr 2024 15:44:28 +0200
Subject: [PATCH] chore: refactor typedoc github action

---
 .github/workflows/typedoc.yml |  1 +
 INSTALL.md                    | 26 ++++++++++++++++++++++++++
 README.md                     |  4 ++++
 3 files changed, 31 insertions(+)
 create mode 100644 INSTALL.md

diff --git a/.github/workflows/typedoc.yml b/.github/workflows/typedoc.yml
index 29e4a543..ca06e56b 100644
--- a/.github/workflows/typedoc.yml
+++ b/.github/workflows/typedoc.yml
@@ -6,6 +6,7 @@ on:
       - "packages/**"
     branches:
       - main
+  workflow_dispatch:
 
 jobs:
   build:
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 00000000..7a2ddf87
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,26 @@
+- [1. Fork repository](#1-fork-repository)
+  - [1.1. Fork main branch](#11-fork-main-branch)
+  - [1.2. Enable workflows](#12-enable-workflows)
+  - [1.3. Configure workflow permissions](#13-configure-workflow-permissions)
+
+## 1. Fork repository
+
+### 1.1. Fork main branch
+
+Fork main branch by clicking [here](https://github.com/brunotot/monorepo-mern-railway-starter/fork)
+
+- you may customize the repository name and description
+- make sure `Copy the main branch only` field is checked
+
+### 1.2. Enable workflows
+
+Go to your personal forked repository and open **Actions** tab.
+
+- click on `I understand my workflows, go ahead and enable them`
+
+### 1.3. Configure workflow permissions
+
+On your personal forked repository, navigate to **Settings -> Actions -> General** and scroll to **Workflow permissions** panel.
+
+- make sure that `Read and write permissions` and `Allow GitHub actions to create and approve pull requests` fields are checked
+- save the new configuration.
diff --git a/README.md b/README.md
index 0773070e..858709f1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,5 @@
 # monorepo-mern-railway-starter
+
+-
+
+# TOC