Skip to content

Commit abada31

Browse files
committed
Add minimal docs
1 parent e2fe3be commit abada31

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

lib/mix/tasks/desktop.install.ex

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,32 @@
11
defmodule Mix.Tasks.Desktop.Install do
2-
@shortdoc "Add Elixir Desktop support to a project"
2+
@shortdoc "Add Elixir Desktop support to an existing project"
33

44
@moduledoc """
55
#{@shortdoc}
6+
7+
This mix task adds the minimal glue to launch an Elixir Desktop
8+
main window for your application.
9+
10+
To use this task, you'll either need to install Igniter globally, or
11+
manually add the desktop dependency to your project's mix.exs:
12+
13+
```
14+
{:desktop, "~> 1.0"}
15+
```
16+
17+
## Examples
18+
19+
Add desktop support to a project:
20+
21+
```bash
22+
mix desktop.install
23+
```
24+
25+
Create a new project with desktop support:
26+
27+
```bash
28+
mix igniter.new --install desktop --with phx.new
29+
```
630
"""
731

832
use Igniter.Mix.Task

0 commit comments

Comments
 (0)