Skip to content

Commit c1d4612

Browse files
committed
docs: Update README
1 parent aa75aa9 commit c1d4612

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99
<h3 align="center">
1010
<a href="https://github.com/ragdata/workflow-templates/issues" target="_blank">Issues</a>
1111
🔸
12-
<a href="https://docs.example.com" target="_blank">Documentation</a>
13-
🔸
1412
<a href="https://github.com/ragdata/workflow-templates/releases" target="_blank">Releases</a>
1513
</h3>
1614

@@ -61,24 +59,18 @@ Currently, the following workflows are included with the project:
6159

6260
When you include a `workflow-templates` directory as part of your personal or organisation's `.github` repository, GitHub will display those templates as selections whenever you create a new workflow using the `New workflow` button under the `Actions` tab for ALL of your repositories.
6361

64-
There are a couple of ways you can set this up.
65-
66-
### Simple Version:
67-
6862
1. Create a directory called `workflow-templates` in the root of your `.github` repository
6963
2. Add your desired `template-name.yml` and `template-name.properties.json` files to the directory.
7064
* You can optionally add `.svg` files to use as icons for your templates, specified as the `iconName` property of the template's `.json` properties file.
7165
3. Add any required configuration files. You can find examples in the `template-configs` directory.
7266

73-
**DONE!**
74-
75-
### The Way I Did It (Reusable):
76-
77-
1. Create a `workflow-templates` repository
78-
2. Create a `templates` directory in the root of that repo
79-
3. Add templates and properties files to the `templates` directory
80-
4. Add your `workflow-templates` repository as a submodule to your personal and organisational `.github` repositories
81-
5. Create a symbolic link in the root of your `.github` repos named `workflow-templates` which points at the directory which contains your templates WITHIN THE SUBMODULE
67+
[//]: # (**DONE!**)
68+
[//]: # (### The Way I Did It &#40;Reusable&#41;:)
69+
[//]: # (1. Create a `workflow-templates` repository)
70+
[//]: # (2. Create a `templates` directory in the root of that repo)
71+
[//]: # (3. Add templates and properties files to the `templates` directory)
72+
[//]: # (4. Add your `workflow-templates` repository as a submodule to your personal and organisational `.github` repositories)
73+
[//]: # (5. Create a symbolic link in the root of your `.github` repos named `workflow-templates` which points at the directory which contains your templates WITHIN THE SUBMODULE)
8274

8375
[`^ Top`](#top)
8476

0 commit comments

Comments
 (0)