Update readme, contributing, toml, and add Makefile

Author: tomfran

CONTRIBUTING.md

@@ -1,19 +1,27 @@
 # How to contribute to Typo
 
-The goal of this theme is to be as simple as possible, hence adding or changing existing 
-features need some thought. 
+The goal of this theme is to be as simple as possible, hence adding or changing existing features needs some thought.
+
+Any change that is too niche or heavily tailored to a specific developer's need will be rejected, as that would make some features cumbersome to set up.
 
-Any change that is too niche or heavily tailored to a specific developer's need will be rejected, as 
-that would make some features cumbersome to set up.
 To avoid unnecessary work, please start a discussion or open an issue with a proposal.
 
-Any other reasonable changes are more than welcome, keep in mind the guidelines: 
+**Guidelines**
+
+Any other reasonable changes are more than welcome. Keep in mind the guidelines:
+
 - keep the code as minimal as possible, and avoid comments in the code unless needed;
 - keep the parameters (e.g. in hugo.toml) as concise and clear as possible;
 - update the [wiki](https://github.com/tomfran/typo/tree/main/wiki) if needed, trying to maintain the current style of writing;
-- refrain from breaking existing behavior, for example, make a new feature disabled by default;
 - squash your change in a single commit.
 
+**On Breaking Changes**
+
+You should avoid breaking existing configs when possible, or you should have a good reason to do so and explain it in your PR.
+
+When introducing a styling change, aim to keep it disabled by default to avoid tweaking people's websites without config changes.
+
+---
 <br>
 Thank you, <br>
-Francesco
+Francesco

Makefile

@@ -0,0 +1,13 @@
+.PHONY: release release-bump release-minor release-major
+
+release:
+	@./scripts/release.sh manual
+
+release-bump:
+	@./scripts/release.sh bump
+
+release-minor:
+	@./scripts/release.sh minor
+
+release-major:
+	@./scripts/release.sh major

README.md

@@ -24,27 +24,27 @@ Typo is a theme backed by simplicity, as you can see in the screenshots below. T
 
 ![3](https://raw.githubusercontent.com/tomfran/typo/main/images/3.webp)
 
-## 1 Wiki
+## Wiki
 
 Typo's [Wiki](https://tomfran.github.io/typo-wiki/) is the place to find instructions on how to [setup](https://tomfran.github.io/typo-wiki/setup) the theme and an overview of the available [features](https://tomfran.github.io/typo-wiki/features). 
 
 Some of the most relevant are: heading auto-numbering, dark mode, color palettes, dark and light images, comments, etc.
 
-## 2 Support
+## Support
 
 If you use the theme or found it useful you can support me by leaving a star ⭐ to Typo's Github repository.
 
 [Contributions](https://github.com/tomfran/typo/blob/main/CONTRIBUTING.md) are always welcome, feel free to open issues and PRs with fixes or new features.
 
-## 3 Typo Users
+## Typo Users
 
 If you're using Typo for your website, feel free to add your website to [the list](https://github.com/tomfran/typo/blob/main/USERS.md) alongside what you do! 😊
 
-## 4 Questions or ideas? 
+## Questions or ideas? 
 
 Use the [discussion tab](https://github.com/tomfran/typo/discussions) to share ideas/tips/questions about Typo or Hugo in general!
 
-## 5 References
+## References
 
 The SVGs for social icons are taken from [Simple Icons](https://github.com/simple-icons/simple-icons).
 Every SVG present on the website is usable on the theme.

scripts/release.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+set -e
+
+TYPE=${1:-manual}
+
+latest=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+echo "Latest tag: $latest"
+
+version=$(echo "$latest" | sed 's/v//')
+IFS='.' read -r major minor patch <<< "$version"
+
+case "$TYPE" in
+    bump|patch)
+        patch=$((patch + 1))
+        new_tag="v$major.$minor.$patch"
+        ;;
+    minor)
+        minor=$((minor + 1))
+        new_tag="v$major.$minor.0"
+        ;;
+    major)
+        major=$((major + 1))
+        new_tag="v$major.0.0"
+        ;;
+    manual)
+        read -p "Enter new tag: " new_tag
+        if [ -z "$new_tag" ]; then
+            echo "No tag provided, aborting."
+            exit 1
+        fi
+        ;;
+    *)
+        echo "Invalid type: $TYPE"
+        echo "Usage: $0 [bump|minor|major|manual]"
+        exit 1
+        ;;
+esac
+
+read -p "Creating tag [$new_tag] Continue? [y/N] " confirm
+if [ "$confirm" = "y" ] || [ "$confirm" = "Y" ]; then
+    git tag "$new_tag"
+    git push origin "$new_tag"
+    echo "Tag $new_tag created and pushed successfully."
+else
+    echo "Tag creation cancelled."
+    exit 1
+fi

theme.toml

@@ -5,7 +5,7 @@ description = 'A simple Hugo theme'
 
 homepage = 'https://github.com/tomfran/typo'
 
-demosite = 'https://tomfran.github.io/'
+demosite = 'https://tomfran.github.io/typo-wiki/'
 
 tags = [
     "responsive",
@@ -33,4 +33,4 @@ features = [
 
 [author]
 name = 'Francesco Tomaselli'
-homepage = 'https://tomfran.github.io/'
+homepage = 'https://tomfran.github.io/typo-wiki/'