Update CHANGELOG.md (#8)

gpedic · Jul 10, 2023 · 88b47b1 · 88b47b1
1 parent 9ccfebb
commit 88b47b1
Showing 1 changed file with 18 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## v3.0.0
-* move most significant bit to the begginging of the encoded result
-* drop support for decoding of unpadded ShortUUIDs
+* move most significant bit to the beginning of the encoded result similar to libraries in other languages (most importantly python shortuuid)
+* drop support for decoding of un-padded ShortUUIDs
 * drop support for formats other than regular hyphenated and unhyphenated UUIDs, MS format and binary UUIDs like are stored in PostgreSQL uuid type
 * refactor code for better readability
 * improve encode and decode performance
@@ -24,23 +24,24 @@ Elixir 1.15.2
 Erlang 25.3.2.3
 
 * v3.0.0
-
-Name                                        ips        average  deviation         median         99th %
-encode/1 binary uuid                  1212.57 K        0.82 μs  ±1995.67%        0.75 μs        1.00 μs
-encode/1 unhyphenated uuid string      788.79 K        1.27 μs   ±984.70%        1.13 μs        1.63 μs
-encode/1 hyphenated uuid string        753.56 K        1.33 μs  ±1106.96%        1.17 μs        1.67 μs
-encode/1 uuid string with braces       722.36 K        1.38 μs  ±1188.51%        1.21 μs        1.83 μs
-decode/1                                 1.15 M      868.43 ns  ±1506.27%         751 ns        1334 ns
+  ```
+  Name                                        ips        average  deviation         median         99th %
+  encode/1 binary uuid                  1212.57 K        0.82 μs  ±1995.67%        0.75 μs        1.00 μs
+  encode/1 unhyphenated uuid string      788.79 K        1.27 μs   ±984.70%        1.13 μs        1.63 μs
+  encode/1 hyphenated uuid string        753.56 K        1.33 μs  ±1106.96%        1.17 μs        1.67 μs
+  encode/1 uuid string with braces       722.36 K        1.38 μs  ±1188.51%        1.21 μs        1.83 μs
+  decode/1                                 1.15 M      868.43 ns  ±1506.27%         751 ns        1334 ns
+  ```
 
 * v2.1.1
-
-Name                                        ips        average  deviation         median         99th %
-encode/1 binary uuid                    1018.43 K        0.98 μs  ±1224.91%        0.88 μs        1.25 μs
-encode/1 unhyphenated uuid string        849.67 K        1.18 μs  ±1171.07%        1.08 μs        1.42 μs
-encode/1 hyphenated uuid string          731.91 K        1.37 μs   ±691.40%        1.29 μs        1.63 μs
-encode/1 uuid string with braces         569.16 K        1.76 μs   ±833.41%        1.63 μs        2.17 μs
-decode/1                                   1.00 M      996.37 ns   ±781.87%         918 ns        1376 ns
-
+  ```
+  Name                                        ips        average  deviation         median         99th %
+  encode/1 binary uuid                    1018.43 K        0.98 μs  ±1224.91%        0.88 μs        1.25 μs
+  encode/1 unhyphenated uuid string        849.67 K        1.18 μs  ±1171.07%        1.08 μs        1.42 μs
+  encode/1 hyphenated uuid string          731.91 K        1.37 μs   ±691.40%        1.29 μs        1.63 μs
+  encode/1 uuid string with braces         569.16 K        1.76 μs   ±833.41%        1.63 μs        2.17 μs
+  decode/1                                   1.00 M      996.37 ns   ±781.87%         918 ns        1376 ns
+  ```
 
 ## v2.1.1 (2019-02-18)