Hotfix/release glitches (#21)

* [fix] horrible typo * [fix] do not read from files not available in release * [0.1.4] bump version
primait · Oct 20, 2022 · d8e96f2 · d8e96f2
1 parent 9e3d9a5
commit d8e96f2
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/lib/redact_ex.ex b/lib/redact_ex.ex
@@ -1,6 +1,6 @@
 defmodule RedactEx do
   @moduledoc """
-  RedactEx provides protocols and derivatoin utilities to work with
+  RedactEx provides protocols and derivation utilities to work with
   sensitive data that should be redacted in logs and external facing tools
 
   * `RedactEx.Redactor` module gives you automagical generation of redacting

diff --git a/lib/redact_ex/redactable.ex b/lib/redact_ex/redactable.ex
@@ -54,7 +54,17 @@ defprotocol RedactEx.Redactable do
   e.g. suppose you define a module like
 
   ```
-  #{File.read!("./test/support/derive/redact_struct.ex")}
+  # ./test/support/derive/redact_struct.ex
+  defmodule MyApp.RedactStruct do
+    @moduledoc false
+
+    # For usage in RedactEx.Redactable doctests
+    @derive {RedactEx.Redactable,
+            fields: [
+              myfield: {String, :reverse}
+            ]}
+    defstruct [:myfield]
+  end
   ```
 
   then you can expect it to have derived the `RedactEx.Redactable` protocol

diff --git a/mix.exs b/mix.exs
@@ -4,7 +4,7 @@ defmodule RedactEx.MixProject do
   def project do
     [
       app: :redact_ex,
-      version: "0.1.3",
+      version: "0.1.4",
       source_url: "https://github.com/primait/redact_ex",
       elixir: "~> 1.12",
       elixirc_paths: elixirc_paths(Mix.env()),