From 699f1da43f5fd60699bca0b499755af939230954 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Fri, 9 Jun 2023 16:28:21 -0500 Subject: [PATCH] Add description to the readme --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8c7e038..a7eaa63 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ replacing every `-` (dash) character with a space. Name your files accordingly. The `Home.md` file will automatically become the homepage, not `README.md`. This is specific to GitHub wikis. -### Options +### Inputs - **`strategy`:** Select from `clone` or `init` to determine which method to use to push changes to the GitHub wiki. `clone` will clone the `.wiki.git` repo @@ -116,7 +116,7 @@ is specific to GitHub wikis. not push to the remote wiki. The default is `false`. This is useful for testing. -#### `strategy:` option +#### `strategy:` input There are some specific usecases where using `strategy: init` might be better than the default `strategy: clone`. @@ -132,6 +132,12 @@ than the default `strategy: clone`. push using `strategy: init` on each wiki deployment and none of that pesky history will be saved. +### Outputs + +- **`wiki_url`:** The HTTP URL that points to the deployed repository's wiki + tab. This is essentially the concatenation of `${{ github.server_url }}`, + `${{ github.repository }}`, and the `/wiki` page. + ### Preprocessing You may wish to strip the `[link](page.md)` `.md` suffix from your links to make