Add new function to Nilsimsa module

philipbrown · Jun 19, 2023 · 0663ddf · 0663ddf
1 parent 47218fa
commit 0663ddf
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ You can also process a stream:
 ```elixir
 "war_and_peace.txt"
 |> File.stream!()
-|> Enum.reduce(Nilsimsa.process(""), &Nilsimsa.process/2)
+|> Enum.reduce(Nilsimsa.new(), &Nilsimsa.process/2)
 ```
 
 ## Generating a digest

diff --git a/lib/nilsimsa.ex b/lib/nilsimsa.ex
@@ -28,6 +28,18 @@ defmodule Nilsimsa do
             threshold: 0.0,
             window: for(_ <- 0..3, do: -1)
 
+  @doc """
+  Create a new Nilsimsa.
+
+  ## Examples
+
+      iex> Nilsimsa.new() |> to_string()
+      "0000000000000000000000000000000000000000000000000000000000000000"
+
+  """
+  def new,
+    do: %__MODULE__{}
+
   @doc """
   Compare two hashed values