Update README.md

solnic · Oct 13, 2023 · 255c1bd · 255c1bd
1 parent 8dfc323
commit 255c1bd
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -245,7 +245,7 @@ UserContract.conform(%{text: "HELLO"})
 
 ### Atomized maps
 
-You can define a schema that will atomize the input map using `atomize: true` option:
+You can define a schema that will atomize the input map using `atomize: true` option. Only keys that you specified will be atomized, any unexpected key will be ignored. Here's an example:
 
 ```elixir
 defmodule UserContract do
@@ -264,6 +264,8 @@ defmodule UserContract do
 end
 
 UserContract.conform(%{
+  "unexpected" => "value",
+  "this" => "should not be here",
   "name" => "Jane",
   "age" => 21,
   "tags" => [
@@ -272,6 +274,13 @@ UserContract.conform(%{
     %{"name" => "blue"}
   ]
 })
+# {:ok,
+#  %{
+#    name: "Jane",
+#    age: 21,
+#    tags: [%{name: "red"}, %{name: "green"}, %{name: "blue"}]
+#  }}
+
 # {:ok,
 #  %{
 #    name: "Jane",

diff --git a/examples/readme/schemas-07.ex b/examples/readme/schemas-07.ex
@@ -14,6 +14,8 @@ defmodule UserContract do
 end
 
 UserContract.conform(%{
+  "unexpected" => "value",
+  "this" => "should not be here",
   "name" => "Jane",
   "age" => 21,
   "tags" => [