doc: show results in README example

floatpays · Aug 15, 2023 · 315e08c · 315e08c
1 parent 2bce1fc
commit 315e08c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -15,7 +15,18 @@ end
 ## Usage
 
 ```elixir
-ZaIdNumber.validate("12345")
+iex> ZaIdNumber.validate("12345")
+{:error, "Invalid ID Number format"}
+
+iex> ZaIdNumber.validate("[valid id number]")
+{:ok, %{
+ gender: :male | :female,
+ age: pos_integer(),
+ date_of_birth: Date.t(),
+ citizen_status: :born_citizen | :permanent_resident
+ }
+}
+
 ```
 
 ## Development

diff --git a/test/za_id_number_test.exs b/test/za_id_number_test.exs
@@ -2,7 +2,7 @@ defmodule ZaIdNumberTest do
  use ExUnit.Case
  doctest ZaIdNumber
 
- test "greets the world" do
+ test "invalid id number" do
  assert ZaIdNumber.validate("1234") == {:error, "Invalid ID Number format"}
  end
 end