Update code branch (#190)

* Create CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Added some install instructions

* Finished CONTRIBUTING.md

* Fixed CONTRIBUTING table

* Added SECURITY.md

* Added Computer Edge instructions

* Added Computer FireFox instructions

* Clarified where the userscript can be downloaded from

* Update to Wiki Docs

* Simplify installation instructions with one-click install links

This is because Tampermonkey automagically detect whether raw js files are being opened and redirect user to installation page. We might need a custom build action to update the links though.

- Replace manual download and drag process with direct install links
- Remove unnecessary screenshots and dashboard steps

* Fix stuff

* Fixed again. Sorry I was looking at the wrong branch T-T

* .

* Added color palette to src/utils.js

* Updated Shields to match HEAD of main

* Added build.yml RegEx for v0.0.0 version updating in README.md

* Branch sync

* Update CONTRIBUTING.md

* Added the quick guide

* Added wplace status shield

* Moved wiki to its own branch

* Added Shields from #61 and #58

* Fixed PR template

* Squashed commit of the following:

commit aca7df4189
Author: SwingTheVine <swingthevine@gmail.com>
Date:   Sat Aug 9 20:52:22 2025 -0400

    Added color palette to src/utils.js

commit 13ff8fbe33
Merge: 70eb0a2 f2d34d8
Author: SwingTheVine <swingthevine@gmail.com>
Date:   Sat Aug 9 20:49:26 2025 -0400

    Merge branch 'main' of https://github.com/SwingTheVine/Wplace-BlueMarble

commit 70eb0a26fa
Author: SwingTheVine <swingthevine@gmail.com>
Date:   Fri Aug 8 19:38:49 2025 -0400

    Update to Wiki Docs

* Fixed bug in JSDoc generation in build.js

* v0.79.0; Merge pull request #98 from SwingTheVine/documentation

Updated documentation

* Added missing dependency for minami

* Added brief description about what Blue Marble does

* v0.80.0; Added brief description about what Blue Marble does

* v0.81.0; Merge branch 'code' into main

* Emergency patch...

...please stop informing me that the install link is broken 😭

* v0.82.0; Emergency patch...

...please stop informing me that the install link is broken 😭

---------

Co-authored-by: thatfrozenfrog <101154752+thatfrozenfrog@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
SwingTheVine 2025-08-17 02:45:08 -04:00 committed by GitHub
parent e8a40af986
commit eadc681d97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -110,6 +110,43 @@
</details>
</p>
<h2>Quick Guide</h2>
<p>
Press the arrows to reveal the option you want.
<details>
<summary>
<b>I want to download Blue Marble.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="#installation-instructions">Click here</a> to view the installation instructions.
</details>
<details>
<summary>
<b>I want to ask questions about Blue Marble.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://discord.gg/tpeBPy46hf" target="_blank" rel="noopener noreferrer">Click here</a> for the Discord server invite to the Blue Marble support server.
<br>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/discussions/categories/q-a">Click here</a> for the GitHub help & question page for Blue Marble.
</details>
<details>
<summary>
<b>I want to report a bug.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues/new/choose">Click here</a> to report a bug, then choose the "Bug Report" option.
</details>
<details>
<summary>
<b>I want to suggest a feature.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/issues/new/choose">Click here</a> to suggest a feature, then choose the Feature Request" option.
</details>
<details>
<summary>
<b>I want to contribute.</b> <sup>(Click to Expand)</sup>
</summary>
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CONTRIBUTING.md">Click here</a> to read the contributing guidelines.
</details>
</p>
<h2>Overview</h2>
<p>
Welcome to Blue Marble! Blue Marble is a userscript for the website <a href="https://wplace.live/" target="_blank" rel="noopener noreferrer">wplace.live</a>. The purpose of Blue Marble is to allow you to take an image, and layer it onto the canvas! That way, you can easily trace the image of your art, without having to look back and forth between multiple tabs/monitors. In addition, Blue Marble supports some neat extra features such as: