mirror of
https://github.com/SwingTheVine/Wplace-BlueMarble.git
synced 2026-05-07 00:09:43 +00:00
Merge pull request #62 from thatfrozenfrog/documentation
Simplify installation instructions with one-click install links
This commit is contained in:
commit
a3c847b30a
2 changed files with 14 additions and 31 deletions
5
.github/workflows/build.yml
vendored
5
.github/workflows/build.yml
vendored
|
|
@ -78,7 +78,10 @@ jobs:
|
|||
else
|
||||
echo "README.md was not found. Skipping..."
|
||||
fi
|
||||
sed -i 's|\(Latest_Version-\)[^-\ ]*\(-lightblue\)|\1'$current_version'\2|' docs/README.md
|
||||
sed -i \
|
||||
-e 's|\(Latest_Version-\)[^-\ ]*\(-lightblue\)|\1'$current_version'\2|' \
|
||||
-e 's|v[0-9]\+\.[0-9]\+\.[0-9]\+|v'"$current_version"'|g' \
|
||||
docs/README.md
|
||||
|
||||
- name: Update compression badge
|
||||
run: |
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@
|
|||
Installation instructions for Blue Marble are below. Click the arrows to expand the instructions you want to see. Blue text is a link.
|
||||
<details>
|
||||
<summary>
|
||||
<b>Install Chrome (Computer)</b> <sup>(Click to Expand)</sup>
|
||||
<b>Install Chrome</b> <sup>(Click to Expand)</sup>
|
||||
</summary>
|
||||
<a href="https://www.youtube.com/watch?v=gg5oiJcftEc" target="_blank" rel="noopener noreferrer"><img alt="Install Tutorial" src="https://img.shields.io/badge/Install_Tutorial-gray?style=flat&logo=YouTube&logoColor=white&logoSize=auto&labelColor=darkred"></a>
|
||||
<ol>
|
||||
|
|
@ -80,25 +80,15 @@
|
|||
<br>
|
||||
<img alt="Enable 'Developer Mode' and 'Allow user scripts'" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall3.png"></li>
|
||||
<li>Enable "Allow user scripts."</li>
|
||||
<li>Download the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank" rel="noopener noreferrer">BlueMarble.user.js</a> file in the "assets" of the latest release.</li>
|
||||
<li>Open the TamperMonkey Dashboard.
|
||||
<li><strong>One-click install:</strong> Click this link to Install Blue Marble directly: <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases/download/v0.76.0/BlueMarble.user.js" target="_blank" rel="noopener noreferrer"><strong>Install Blue Marble</strong></a>
|
||||
<br>
|
||||
<img alt="Enter the TamperMonkey 'Dashboard'" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall4.png"></li>
|
||||
<li>Drag the <code>BlueMarble.user.js</code> file inside the dashboard of TamperMonkey.
|
||||
<br>
|
||||
<img alt="Drag the userscript into the dashboard" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall5.png"></li>
|
||||
<li>Click the "Install" button to install Blue Marble.
|
||||
<br>
|
||||
<img alt="Click the 'Install' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall6.png"></li>
|
||||
<li>Enable Blue Marble inside the TamperMonkey dashboard.
|
||||
<br>
|
||||
<img alt="Enable Blue Marble" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall7.png"></li>
|
||||
TamperMonkey will automatically detect the userscript and prompt you to Install it.</li>
|
||||
<li>Refresh the <a href="https://wplace.live/" target="_blank" rel="noopener noreferrer">wplace.live</a> webpage.</li>
|
||||
</ol>
|
||||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
<b>Install Edge (Computer)</b> <sup>(Click to Expand)</sup>
|
||||
<b>Install Edge</b> <sup>(Click to Expand)</sup>
|
||||
</summary>
|
||||
<ol>
|
||||
<li>Install the <a href="https://microsoftedge.microsoft.com/addons/detail/iikmkjmpaadaobahmlepeloendndfphd" target="_blank" rel="noopener noreferrer">TamperMonkey</a> plugin for Microsoft Edge.
|
||||
|
|
@ -117,8 +107,8 @@
|
|||
<img alt="Enter the TamperMonkey 'Dashboard'" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerEdgeInstall4.png"></li>
|
||||
<li>Drag the <code>BlueMarble.user.js</code> file inside the dashboard of TamperMonkey.
|
||||
<br>
|
||||
<img alt="Drag the userscript into the dashboard" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerEdgeInstall5.png"></li>
|
||||
<li>Click the "Install" button to install Blue Marble.
|
||||
<img alt="Drag the userscript into the dashboard" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall5.png"></li>
|
||||
<li>Click the "Install" button to Install Blue Marble.
|
||||
<br>
|
||||
<img alt="Click the 'Install' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall6.png"></li>
|
||||
<li>Enable Blue Marble inside the TamperMonkey dashboard.
|
||||
|
|
@ -129,25 +119,15 @@
|
|||
</details>
|
||||
<details>
|
||||
<summary>
|
||||
<b>Install Firefox (Computer)</b> <sup>(Click to Expand)</sup>
|
||||
<b>Install FireFox</b> <sup>(Click to Expand)</sup>
|
||||
</summary>
|
||||
<ol>
|
||||
<li>Install the <a href="https://addons.mozilla.org/en-US/firefox/addon/tampermonkey/" target="_blank" rel="noopener noreferrer">TamperMonkey</a> plugin for Firefox.
|
||||
<br>
|
||||
<img alt="Click the 'Add to Firefox' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerFirefoxInstall1.png"></li>
|
||||
<li>Download the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank" rel="noopener noreferrer">BlueMarble.user.js</a> file in the "assets" of the latest release.</li>
|
||||
<li>Open the TamperMonkey Dashboard.
|
||||
<img alt="Click the 'Add to FireFox' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerFireFoxInstall1.png"></li>
|
||||
<li><strong>One-click install:</strong> Click this link to Install Blue Marble directly: <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases/download/v0.76.0/BlueMarble.user.js" target="_blank" rel="noopener noreferrer"><strong>Install Blue Marble</strong></a>
|
||||
<br>
|
||||
<img alt="Enter the TamperMonkey 'Dashboard'" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerFirefoxInstall2.png"></li>
|
||||
<li>Drag the <code>BlueMarble.user.js</code> file inside the dashboard of TamperMonkey.
|
||||
<br>
|
||||
<img alt="Drag the userscript into the dashboard" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerFirefoxInstall3.png"></li>
|
||||
<li>Click the "Install" button to install Blue Marble.
|
||||
<br>
|
||||
<img alt="Click the 'Install' button" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall6.png"></li>
|
||||
<li>Enable Blue Marble inside the TamperMonkey dashboard.
|
||||
<br>
|
||||
<img alt="Enable Blue Marble" src="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/assets/ComputerChromeInstall7.png"></li>
|
||||
TamperMonkey will automatically detect the userscript and prompt you to Install it.</li>
|
||||
<li>Refresh the <a href="https://wplace.live/" target="_blank" rel="noopener noreferrer">wplace.live</a> webpage.</li>
|
||||
</ol>
|
||||
</details>
|
||||
|
|
|
|||
Loading…
Reference in a new issue