docs: minor tweak of the release notes

chevdor · Jul 7, 2021 · de175bb · de175bb
1 parent 5e36b5c
commit de175bb
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 17 deletions.
diff --git a/templates/changelog.md b/templates/changelog.md
@@ -1,12 +1,12 @@
-{% if commits | length %}
-# Changes since {{ since }}
+{%- if commits | length %}
+## Changes since {{ since }}
 
 {% for commit in commits %}
 {%- set s = commit.message | split(pat=":") -%}
 {% if s | length > 1 -%}
- - {{ commit.short_sha }}: {{ s.0 }} -{{ s.1 }} [@{{ commit.author }}]
+ - {{ commit.short_sha }}: {{ s.0 }} -{{ s.1 }}
 {% else -%}
- - {{ commit.short_sha }}: {{ commit.message }} [@{{ commit.author }}]
+ - {{ commit.short_sha }}: {{ commit.message }}
 {% endif -%}
 {%- endfor %}
 

diff --git a/templates/release.md b/templates/release.md
@@ -1,30 +1,24 @@
-# Description
-
-You can find the changelogs below.
-
-# Downloads
+## Downloads
 
 Download the binary for your OS from below:
-- **Linux**
-    - [Debian package]({{ DEBIAN_URL }})
-- **MacOS**
-    - [Archive]({{ MACOS_TGZ_URL }})
-# Install
+- **Linux**: [Debian package]({{ DEBIAN_URL }})
+- **MacOS**: [.tgz Archive]({{ MACOS_TGZ_URL }})
+## Install
 
-## From source
+### From source
 
 ```
 cargo install --git https://github.com/chevdor/subwasm
 ```
 
-## Linux
+### Linux
 ```
 wget {{ DEBIAN_URL }} -O subwasm.deb
 sudo dpkg -i subwasm.deb
 subwasm --help
 ```
 
-## MacOS
+### MacOS
 
 ```
 brew tap chevdor/subwasm https://github.com/chevdor/subwasm