Improve docs & readme & small refactor

2022-09-02 13:49:03 -04:00
parent 65fb8c6988
commit cf2401336d
8 changed files with 49 additions and 18 deletions
--- a/lib/mix/tasks/heroicons/update.ex
+++ b/lib/mix/tasks/heroicons/update.ex
@ -1,9 +1,17 @@
 defmodule Mix.Tasks.Heroicons.Update do
  @moduledoc """
  Update heroicons.
-  By default, it downloads the latest version but you
-  can configure it in your config files, such as:
+
+  By default, it downloads the latest version but you can configure it
+  in your config files.
+
+  Example:
+
      config :heroicons, :version, "#{Heroicons.latest_version()}"
+
+  Then update with
+
+      $ mix heroicons.update
  """

  @shortdoc "Update heroicons assets"