docs: update installation guide

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [unreleased]
+## [0.1.0](https://github.com/stack-rs/mitosis/releases/tag/mito-v0.1.0) - 2024-11-05
 
 ### Features
 
@@ -100,6 +100,11 @@ All notable changes to this project will be documented in this file.
 ### Miscellaneous Tasks
 
 - *(cliff)* Set values for Github integration - ([e049956](https://github.com/stack-rs/mitosis/commit/e0499567f524cd9cb48070f7d17a50a676687fcd))
+- Specify version for netmito in mito - ([4394da2](https://github.com/stack-rs/mitosis/commit/4394da26ad268f965d557c1d61de29327a32c40e))
+- Remove extra keywords in manifest - ([748ed1d](https://github.com/stack-rs/mitosis/commit/748ed1d245e4beef0692263a2bfed5bf73ff94ba))
+- Add manifest metadata - ([ab301fd](https://github.com/stack-rs/mitosis/commit/ab301fd30645d8ce1b86840866910a4b17643423))
+- Update release-plz workflow - ([48a47e9](https://github.com/stack-rs/mitosis/commit/48a47e9d544e1b0a443182c28ae8f1c39d769477))
+- Add CHANGELOG - ([7e184fd](https://github.com/stack-rs/mitosis/commit/7e184fdee5b41d66b93729a070ff0514c4f08b50))
 - Add release workflows - ([e18f8db](https://github.com/stack-rs/mitosis/commit/e18f8db399f93fe9903c16ce1f1f65a386d01a65))
 - Add site-url to mdbook build - ([6e5d053](https://github.com/stack-rs/mitosis/commit/6e5d05341e7fcb3a2acda3b65fc90a225e430edd))
 - Add gh-page build workflow - ([a80ff39](https://github.com/stack-rs/mitosis/commit/a80ff394d7c98c16fa47b9bc92b4ee255c7721aa))

cliff.toml

@@ -61,7 +61,6 @@ body = """
 {%- endfor -%}
 {%- endif %}
 
-
 """
 # template for the changelog footer
 footer = """

guide/src/guide/installation.md

@@ -6,16 +6,27 @@ and a SDK library (named `netmito`) that you can use to create your own client.
 There are multiple ways to install the Mitosis CLI tool.
 Choose any one of the methods below that best suit your needs.
 
-> **ATTENTION**: As we are still in the early stages of development without a released version, we only support building from source currently.
-
 ## Pre-compiled binaries
 
 Executable binaries are available for download on the [GitHub Releases page][releases].
 Download the binary and extract the archive.
 The archive contains an `mito` executable which you can run to start your distributed platform.
 
 To make it easier to run, put the path to the binary into your `PATH` or install it in a directory that is already in your `PATH`.
-For example, do `sudo install -m 755 mito /usr/local/bin/mito` on Linux.
+For example, do the following on Linux:
+
+```bash
+wget https://github.com/stack-rs/mitosis/releases/download/mito-v0.1.0/mito-x86_64-unknown-linux-gnu.tar.xz
+tar xf mito-x86_64-unknown-linux-gnu.tar.xz
+cd mito-x86_64-unknown-linux-gnu
+sudo install -m 755 mito /usr/local/bin/mito
+```
+
+We also have a installer script that you can use to install the latest version of Mitosis. You can change the version number in the URL to install a specific version. This script will install the binary in the `$HOME/.cargo/bin` directory.
+
+```bash
+curl --proto '=https' --tlsv1.2 -LsSf https://github.com/stack-rs/mitosis/releases/download/mito-v0.1.0/mito-installer.sh | sh
+```
 
 [releases]: https://github.com/stack-rs/mitosis/releases
 

release-plz.toml

@@ -2,7 +2,7 @@
 
 [workspace]
 # path of the git-cliff configuration
-changelog_config = "cliff.toml"
+# changelog_config = "cliff.toml"
 # enable changelog updates
 changelog_update = true
 # update dependencies with `cargo update`
@@ -21,6 +21,81 @@ publish_allow_dirty = true
 # disable running `cargo-semver-checks`
 semver_check = true
 
+[changelog]
+header = """# Changelog
+
+All notable changes to this project will be documented in this file.
+
+"""
+
+body = """
+{%- macro remote_url() -%}
+  https://github.com/stack-rs/mitosis
+{%- endmacro -%}
+
+{% macro print_commit(commit) -%}
+    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+        {% if commit.breaking %}[**breaking**] {% endif %}\
+        {{ commit.message | upper_first }} - \
+        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
+{% endmacro -%}
+
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}]\
+    {%- if release_link -%}\
+        ({{ release_link }})\
+    {% endif %} \
+    - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        {{ self::print_commit(commit=commit) }}
+    {%- endfor %}
+    {% for commit in commits %}
+        {%- if not commit.scope -%}
+            {{ self::print_commit(commit=commit) }}
+        {% endif -%}
+    {% endfor -%}
+{% endfor -%}
+{%- if github -%}
+{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
+  ## New Contributors
+{% endif %}\
+{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
+  - @{{ contributor.username }} made their first contribution
+    {%- if contributor.pr_number %} in \
+      [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
+    {%- endif %}
+{%- endfor -%}
+{%- endif %}
+
+"""
+
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->Features" },
+  { message = "^fix", group = "<!-- 1 -->Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->Documentation" },
+  { message = "^perf", group = "<!-- 4 -->Performance" },
+  { message = "^refactor\\(clippy\\)", skip = true },
+  { message = "^refactor", group = "<!-- 2 -->Refactor" },
+  { message = "^style", group = "<!-- 5 -->Styling" },
+  { message = "^test", group = "<!-- 6 -->Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore\\(npm\\).*yarn\\.lock", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->Security" },
+  { message = "^revert", group = "<!-- 9 -->Revert" },
+]
+
 [[package]]
 name = "mito"
 changelog_include = ["netmito"]