SNIPPET: readme as moduledoc

readme_as_moduledoc.ex

defmodule Thing do
  # get the full qualified path to the README.
  @readme_path Path.join(__DIR__, "../README.md")
  # ensure the module recompiles if the README changes
  # NOTE: @external_resource requires a fully qualified path.
  @external_resource @readme_path
  # read the README into the moduledoc
  @moduledoc File.read!(@readme_path)
end