Skip to content

Commit 38bef47

Browse files
committed
Add doc to install
1 parent 0f61629 commit 38bef47

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

lib/tasks/install.ex

+11
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@ defmodule Mix.Tasks.Bloom.Install do
22
@moduledoc "Mix task to install components from the Bloom library"
33
use Mix.Task
44

5+
@doc """
6+
Run the mix task with the component name as an argument to install the component.
7+
8+
## Examples
9+
10+
iex> Mix.Tasks.Bloom.Install.run(["component_name"])
11+
"component_name component installed successfully."
12+
13+
iex> Mix.Tasks.Bloom.Install.run(["nonexistent_component"])
14+
"Component not found: nonexistent_component"
15+
"""
516
@impl true
617
def run(args) do
718
case args do

mix.exs

-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ defmodule Bloom.MixProject do
2626
{:phoenix_html, "~> 4.0"},
2727
{:phoenix_html_helpers, "~> 1.0"},
2828
{:mox, "~> 1.0", only: :test}
29-
# {:dep_from_hexpm, "~> 0.3.0"},
30-
# {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
3129
]
3230
end
3331
end

0 commit comments

Comments
 (0)