Deprecate docception

evnu · Sep 19, 2023 · a824cee · a824cee
1 parent 8eb7b8b
commit a824cee
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,25 @@
 
 Run doctests on arbitrary markdown files.
 
+## DEPRECATION NOTICE
+
+As of Elixir 1.15, this dependency can be replaced by using the
+[doctest_file/1,2](https://hexdocs.pm/ex_unit/1.15/ExUnit.DocTest.html#doctest_file/2) macro
+provided by ExUnit itself, see #11 (thanks @axelson for pointing this out). To use this
+on a range of files, you can create a simple test module in your `test/` directory:
+
+```elixir
+defmodule DocTest do
+  use ExUnit.Case
+  # You could also use a wildcard below
+  for file <- ["README.md"] do
+    doctest_file(file)
+  end
+end
+```
+
+---
+
 ## Usage
 
     $ mix docception markdown-files