From 1524b778f43cf8e03f26d6c4ab78f61591d14be0 Mon Sep 17 00:00:00 2001 From: Shahryar Tavakkoli Date: Sat, 2 Nov 2024 08:55:46 +0330 Subject: [PATCH] Add CHANGELOG and edit LiveBook --- CHANGELOG.md | 5 +++++ guidance/guarded-struct.livemd | 7 ++++--- mix.exs | 3 ++- 3 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..41f0aa4 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog for GuardedStruct 0.0.1 + +- Detach from the Mishka developer tools library +- Remove optional libraries (must be enabled by the user) +- Improvements in some tests diff --git a/guidance/guarded-struct.livemd b/guidance/guarded-struct.livemd index 63fbc64..e52d8bc 100644 --- a/guidance/guarded-struct.livemd +++ b/guidance/guarded-struct.livemd @@ -3,13 +3,14 @@ ```elixir Mix.install([ {:guarded_struct, "~> 0.0.1"} - # Optional dependencies {:html_sanitize_ex, "~> 1.4.3"}, + + # Optional dependencies, It’s recommended to create your own + # custom validation and sanitization functions instead of + # enabling these libraries. {:email_checker, "~> 0.2.4"}, {:ex_url, "~> 2.0"}, {:ex_phone_number, "~> 0.4.3"}, - {:ecto_sql, "~> 3.11"}, - {:postgrex, "~> 0.17.2"} ]) ``` diff --git a/mix.exs b/mix.exs index 6e71568..a7d50dd 100644 --- a/mix.exs +++ b/mix.exs @@ -45,7 +45,8 @@ defmodule GuardedStruct.MixProject do links: %{ "Mishka" => "https://mishka.tools", "GitHub" => @source_url, - "Changelog" => "#{@source_url}/blob/master/CHANGELOG.md" + "Changelog" => "#{@source_url}/blob/master/CHANGELOG.md", + "LiveBook document" => "#{@source_url}/blob/master/guidance/guarded-struct.livemd" } ] end