Added brief description about what Blue Marble does

This commit is contained in:
SwingTheVine 2025-08-10 22:32:23 -04:00
parent 2771018ce5
commit 66c16e22bf
3 changed files with 26 additions and 7 deletions

View file

@ -70,18 +70,27 @@ jobs:
echo "Current version: $current_version" echo "Current version: $current_version"
echo "current_version=$current_version" >> $GITHUB_OUTPUT echo "current_version=$current_version" >> $GITHUB_OUTPUT
- name: Get latest release tag (no "v" prefix)
id: get_latest_tag
run: |
latest_tag=$(gh release list --limit 1 --exclude-drafts --exclude-pre-releases=false | head -n 1 | awk '{print $1}')
latest_tag_no_v=${latest_tag#v}
echo "latest_tag_no_v=$latest_tag_no_v" >> $GITHUB_OUTPUT
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Update static version numbers - name: Update static version numbers
run: | run: |
current_version=${{ steps.get_version.outputs.current_version }} current_version="${{ steps.get_latest_tag.outputs.latest_tag_no_v }}"
if [ -f "docs/README.md" ]; then if [ -f "docs/README.md" ]; then
echo "README.md exists. Modifying..." echo "README.md exists. Modifying..."
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
else else
echo "README.md was not found. Skipping..." echo "README.md was not found. Skipping..."
fi fi
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 - name: Update compression badge
run: | run: |

View file

@ -97,7 +97,17 @@
<h2>Overview</h2> <h2>Overview</h2>
<p> <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>. If you like this userscript, please ⭐ the repository! If you wish to contribute to Blue Marble, check out the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">CONTRIBUTING.md</a> file in <code>docs/</code>. 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:
<ul>
<li>Displaying the number of pixels you need to level up</li>
<li>Displaying a simple coordinate system (tile coordinats & pixel coordinates)</li>
<li>Allowing you to move the color palette to the top of the screen when placing pixels</li>
<li>Allowing you to use the eyedropper on the template image, provided the colors are correct</li>
<li>...and more!</li>
</ul>
If you like this userscript, please ⭐ the repository! If you wish to contribute to Blue Marble, check out the <a href="https://github.com/SwingTheVine/Wplace-BlueMarble/blob/main/docs/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer">CONTRIBUTING.md</a> file in <code>docs/</code>.
<img alt="Showcase image of Blue Marble template" src="./assets/Showcase1.png">
<h3>Installation Instructions</h3> <h3>Installation Instructions</h3>
<a href="" target="_blank" rel="noopener noreferrer"><img alt="Supported Browsers" src="https://img.shields.io/badge/Supported%20Browsers-Chrome%20%7C%20Firefox%2A%20%7C%20Safari%20%7C%20Edge%20%7C%20Brave-orange?style=flat"></a> <a href="" target="_blank" rel="noopener noreferrer"><img alt="Supported Browsers" src="https://img.shields.io/badge/Supported%20Browsers-Chrome%20%7C%20Firefox%2A%20%7C%20Safari%20%7C%20Edge%20%7C%20Brave-orange?style=flat"></a>

BIN
docs/assets/Showcase1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB