mirror of
https://github.com/SwingTheVine/Wplace-BlueMarble.git
synced 2026-01-11 22:40:18 +00:00
Updated README.md and other github files
This commit is contained in:
parent
9adc28431f
commit
dea3c9653c
4 changed files with 81 additions and 2 deletions
|
|
@ -1,2 +0,0 @@
|
|||
# Wplace-BlueMarble
|
||||
A userbot for wplace.live
|
||||
25
docs/CREDITS.md
Normal file
25
docs/CREDITS.md
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
██████╗ ██╗ ██╗ ██╗███████╗
|
||||
██╔══██╗██║ ██║ ██║██╔════╝
|
||||
██████╔╝██║ ██║ ██║█████╗
|
||||
██╔══██╗██║ ██║ ██║██╔══╝
|
||||
██████╔╝███████╗╚██████╔╝███████╗
|
||||
╚═════╝ ╚══════╝ ╚═════╝ ╚══════╝
|
||||
|
||||
|
||||
███╗ ███╗ █████╗ ██████╗ ██████╗ ██╗ ███████╗
|
||||
████╗ ████║██╔══██╗██╔══██╗██╔══██╗██║ ██╔════╝
|
||||
██╔████╔██║███████║██████╔╝██████╔╝██║ █████╗
|
||||
██║╚██╔╝██║██╔══██║██╔══██╗██╔══██╗██║ ██╔══╝
|
||||
██║ ╚═╝ ██║██║ ██║██║ ██║██████╔╝███████╗███████╗
|
||||
╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝╚═════╝ ╚══════╝╚══════╝
|
||||
|
||||
|
||||
---------------------------------------------------
|
||||
|
||||
"Blue Marble" is made by SwingTheVine
|
||||
|
||||
The favicon "Blue Marble" is owned by NASA
|
||||
|
||||
Special Thanks:
|
||||
* nof, [darkness](https://github.com/TouchedByDarkness) for creating similar userscripts!
|
||||
* TheBlueCorner for getting me interested in online pixel canvases!
|
||||
56
docs/README.md
Normal file
56
docs/README.md
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
<table>
|
||||
<tr>
|
||||
<td><a href="#blue-marble">Blue Marble</a></td>
|
||||
<td valign="top" rowspan="99"><a href="https://discord.gg/tpeBPy46hf"><img alt="Discord Banner" src="https://discord.com/api/guilds/796124137042608188/widget.png?style=banner4"></a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> <a href="#overview">Overview</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> <a href="#how-versioning-works">How Versioning Works</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> <a href="#licenses">Licenses</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> <a href="#faq">FAQ</a></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h1>Blue Marble</h1>
|
||||
<a href="" target="_blank"><img alt="Latest Version" src="https://img.shields.io/badge/Latest_Version-0.1.0-lightblue?style=flat"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/releases" target="_blank"><img alt="Latest Release" src="https://img.shields.io/github/v/release/SwingTheVine/Wplace-BlueMarble?sort=date&style=flat&label=Latest%20Release&color=blue"></a>
|
||||
<a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/LICENSE.txt" target="_blank"><img alt="Software License: MPL-2.0" src="https://img.shields.io/badge/Software_License-GPL--3.0-brightgreen?style=flat"></a>
|
||||
<a href="https://discord.gg/tpeBPy46hf" target="_blank"><img alt="Contact Me" src="https://img.shields.io/badge/Contact_Me-gray?style=flat&logo=Discord&logoColor=white&logoSize=auto&labelColor=cornflowerblue"></a>
|
||||
<a href="" target="_blank"><img alt="WakaTime" src="https://img.shields.io/badge/Coding_Time-10hrs_0mins-blue?style=flat&logo=wakatime&logoColor=black&logoSize=auto&labelColor=white"></a>
|
||||
<a href="" target="_blank"><img alt="Total Patches" src="https://img.shields.io/badge/Total_Patches-431-black?style=flat"></a>
|
||||
<a href="" target="_blank"><img alt="Total Lines of Code" src="https://tokei.rs/b1/github/SwingTheVine/Wplace-BlueMarble?category=code"></a>
|
||||
<a href="" target="_blank"><img alt="Total Comments" src="https://tokei.rs/b1/github/SwingTheVine/Wplace-BlueMarble?category=comments"></a>
|
||||
<a href="" target="_blank"><img alt="Build" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/build.yml/badge.svg"></a>
|
||||
<a href="" target="_blank"><img alt="CodeQL" src="https://github.com/SwingTheVine/Wplace-BlueMarble/actions/workflows/github-code-scanning/codeql/badge.svg"></a>
|
||||
|
||||
<h2>Overview</h2>
|
||||
<p>
|
||||
TBA
|
||||
</p>
|
||||
|
||||
<h2>How Versioning Works</h2>
|
||||
<p>
|
||||
The versioning system for this userscript follows the <a href="https://semver.org/" target="_blank">Semantic Versioning rules</a>. As such, it is formatted in an <code>X.Y.Z</code> format where:
|
||||
<ul>
|
||||
<li>X is the major version. This is incremented when a non-backward compatible update is pushed. This is for new features that break previous versions of the userscript. Additionally, if wplace.live breaks the userscript, this will be incremented.</li>
|
||||
<li>Y is the minor version. This is incremented whenever I push to GitHub. This is for stable bug-fixes and new (non-breaking) features.</li>
|
||||
<li>Z is the patch version. This is incremented whenever I launch a development version of the userscript to test a patch. This is for unstable bug-fixes/features.</li>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
<h2>Licenses</h2>
|
||||
<p>
|
||||
(Below, all mentions of the "userscript" refer to the "Blue Marble" userscript made by SwingTheVine) <br>
|
||||
Most of this userscript is licensed under the <code>Mozilla Public License Version 2.0</code> (MPL-2.0). All software, code, and libraries in this repository are licensed under the MPL-2.0 license. However, the "Blue Marble" image in this userscript is owned by NASA and is licensed under the <code>Creative Commons 0 1.0 Universal</code> (CC0 1.0) license.
|
||||
</p>
|
||||
|
||||
<h2>FAQ<h2>
|
||||
<p>
|
||||
TBA
|
||||
</p>
|
||||
Loading…
Reference in a new issue