Skip to content

Commit 6d5d778

Browse files
committed
Update versioning convention
1 parent d774262 commit 6d5d778

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
- Primary features work without JavaScript
2222
- Dark Mode
2323

24+
## Requirements
25+
- [Hugo](https://gohugo.io/installation/) extended edition, v0.158 or higher
26+
2427
## Quick Start
2528
Use the [starter repository](https://github.com/alex-shpak/hugo-book-starter):
2629

@@ -31,14 +34,11 @@ git submodule update --init --remote
3134
hugo server --minify
3235
```
3336

34-
## Requirements
35-
- [Hugo](https://gohugo.io/installation/) extended edition, v0.158 or higher
36-
3737
## Documentation
3838
Example site is self-documenting at [book.alxs.dev](https://book.alxs.dev)
3939

4040
## Versioning
41-
This theme follows a simple incremental versioning. e.g. `v1.0.0`, `v2.0.0` and so on. Releases will happen on breaking changes.
41+
This theme follows a simple incremental versioning by updating minor SemVer version `v0.13.0`, `v0.14.0` and so on. Breaking changes are expected between releases. Note that previously theme used simple `v1`-`v11` versioning, but switch was made for better hugo modules support.
4242

4343
If you want lower maintenance, use one of the released versions. If you want to live on the bleeding edge of changes, you can use the `main` branch and update your website when needed, this also the default branch.
4444

@@ -51,5 +51,3 @@ Primary goals are:
5151
- Keep minimal (or zero) default configuration.
5252
- Avoid interference with user-defined layouts.
5353
- Avoid using JS if it can be solved by CSS.
54-
55-
Feel free to open issues if you find missing configuration or customisation options.

0 commit comments

Comments
 (0)