Updated documentation

bryanjos · bryanjos · commit ad63eaf00286 · 2016-05-14T13:50:16.000-05:00
diff --git a/lib/elixir_script/watcher.ex b/lib/elixir_script/watcher.ex
@@ -2,6 +2,11 @@ defmodule ElixirScript.Watcher do
   use GenServer
   require Logger
 
+  @moduledoc """
+  Watches the input folder for changes and calls the ElixirScript compiler
+  """
+
+
   def start_link(input, options) do
     GenServer.start_link(__MODULE__, [input: input, options: options])
   end
diff --git a/lib/mix/tasks/compile.elixir_script.ex b/lib/mix/tasks/compile.elixir_script.ex
@@ -4,7 +4,7 @@ defmodule Mix.Tasks.Compile.ElixirScript do
   @moduledoc """
   Mix compiler to allow mix to compile Elixirscript source files into JavaScript
 
-  Looks for an `elixirscript` key in your mix project config
+  Looks for an `elixir_script` key in your mix project config
 
       def project do
       [
diff --git a/lib/mix/tasks/elixirscript.watch.ex b/lib/mix/tasks/elixirscript.watch.ex
@@ -3,6 +3,25 @@ defmodule Mix.Tasks.Elixirscript.Watch do
 
   @shortdoc "Watches ElixirScript files for changes"
 
+  @moduledoc """
+  Watches ElixirScript files for changes
+
+  Looks for the `elixir_script` key in your mix project config
+
+  def project do
+  [
+  app: :my_app,
+  version: "0.1.0",
+  elixir: "~> 1.0",
+  deps: deps,
+  elixir_script: [ input: "src/exjs", output: "dest/js"],
+  compilers: [:elixir_script] ++ Mix.compilers
+  ]
+  end
+  """
+
+
+
   def run(_) do
     Mix.Task.run "app.start"
 

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ defmodule Mix.Tasks.Compile.ElixirScript do`
`4`	`4`	`@moduledoc """`
`5`	`5`	`Mix compiler to allow mix to compile Elixirscript source files into JavaScript`
`6`	`6`
`7`		- Looks for an `elixirscript` key in your mix project config
	`7`	+ Looks for an `elixir_script` key in your mix project config
`8`	`8`
`9`	`9`	`def project do`
`10`	`10`	`[`