release v5.0.0

CHANGELOG.md

@@ -10,13 +10,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 <!-- ### Added | Changed | Deprecated | Removed | Fixed | Security -->
 
+<!--------------------- Don't add new entries after this line --------------------->
+
+## [5.0.0] - 2023-11-03
+
+Although this release contains only fixes but as the encoding changes, we
+consider it a breaking change. Hence the major bump.
+
 ### Fixed
 
 - handle "\n" strings - [#157](https://github.com/ufirstgroup/ymlr/issues/157),[#159](https://github.com/ufirstgroup/ymlr/pull/159)
 - handle empty list - [#163](https://github.com/ufirstgroup/ymlr/pull/163)
 
-<!--------------------- Don't add new entries after this line --------------------->
-
 ## [4.2.0] - 2023-08-18
 
 ### Added

README.md

@@ -20,7 +20,7 @@ The package can be installed by adding `ymlr` to your list of dependencies in `m
 ```elixir
 def deps do
   [
-    {:ymlr, "~> 4.0"}
+    {:ymlr, "~> 5.0"}
   ]
 end
 ```
@@ -78,7 +78,6 @@ to parse it later using [`YamlElixir`'s `atoms`
 option](https://hexdocs.pm/yaml_elixir/readme.html#support-for-atoms), you can
 pass `atoms: true` as second argument to any of the `Ymlr` module's functions:
 
-
 ```elixir
 iex> Ymlr.document!(%{a: 1}, atoms: true)
 """
@@ -88,6 +87,7 @@ iex> Ymlr.document!(%{a: 1}, atoms: true)
 ```
 
 ### Encode maps with keys sorted
+
 Maps in elixir, implemented by erlang `:maps`, internally are `flatmap`s or `hashmap`s by size.
 Large maps will be encoded in strange order.
 

mix.exs

@@ -2,7 +2,7 @@ defmodule Ymlr.MixProject do
   use Mix.Project
 
   @source_url "https://github.com/ufirstgroup/ymlr"
-  @version "4.2.0"
+  @version "5.0.0"
 
   def project do
     [