More documentation updates

bryanjos · bryanjos · commit 95c2647dcee5 · 2017-08-08T16:55:14.000-05:00
diff --git a/GettingStarted.md b/GettingStarted.md
diff --git a/README.md b/README.md
@@ -11,7 +11,35 @@ Requirements
 Usage
 ========
 
-Please check the [Getting Started Guide](GettingStarted.md) for usage
+Add dependency to your deps in mix.exs:
+
+``` elixir
+{:elixir_script, "~> x.x"}
+```
+
+Add `elixir_script` to list of mix compilers in mix.exs
+Also add `elixir_script` configuration
+
+```elixir
+  def project do
+  [
+    app: :my_app,
+    # ...
+    # Add elixir_script as a compilter
+    compilers: Mix.compilers ++ [:elixir_script],
+    # Our elixir_script configuration
+    elixir_script: [
+        # Entry module. Can also be a list of modules
+        input: MyEntryModule,
+        # Output path. Either a path to a js file or a directory
+        output: "priv/elixir_script/build/Elixir.App.js"
+    ]
+  ]
+  end
+```
+
+Run `mix compile`
+
 
 Examples
 ==========
diff --git a/lib/elixir_script.ex b/lib/elixir_script.ex
@@ -1,3 +1,71 @@
 defmodule ElixirScript do
-  @moduledoc false
+  @moduledoc """
+
+  ElixirScript acts as a mix compiler. This means that when you execute `mix compile`,
+  ElixirScript's compiler will run as well. Make sure to add ElixirScript to your
+  list of compilers in mix.exs.
+
+  ElixirScript must be told which modules to use as the entry to your ElixirScript application.
+  This is done by adding an `elixir_script` key to your project configuration whose value is a keyword list of options.
+  Add an `input` key and make the value either the name of a module or a list of modules
+  that are the entry modules you wish to compile to JavaScript. ElixirScript will use
+  those modules to find what other modules and functions it needs to convert to JavaScript.
+  ElixirScript by default places output in `priv/elixir_script/build`. If you wish to change this,
+  add an `output` key to your ElixirScript configuration.
+
+  An example configuration for a project is shown below
+
+  ``` elixir
+      def project do
+      [
+      app: :my_app,
+      version: "0.1.0",
+      elixir: "~> 1.0",
+      deps: deps,
+      # Add elixir_script as a compilter
+      compilers: Mix.compilers ++ [:elixir_script],
+      # Our elixir_script configuration
+      elixir_script: [
+          # Entry module. Can also be a list of modules
+          input: MyEntryModule,
+          # Output path. Either a path to a js file or a directory
+          output: "priv/elixir_script/build/Elixir.App.js"
+      ]
+      ]
+      end
+  ```
+
+  Available options are:
+
+  * `input` (required): The entry module(s) for your application or library
+
+  * `output`: The path of the generated JavaScript file. (defaults to `priv/elixir_script/build`)
+
+      If path ends in `.js` then that will be the name of the file. If a directory is given,
+      file will be named `Elixir.App.js`
+
+  * `root`: Optional root for imports of FFI JavaScript modules. Defaults to `.`. If using output directly in a browser, you may want to make it something like `/js` or some uri.
+
+
+  Now run `mix compile` and you should see a JavaScript file named `Elixir.App.js` in the `priv/elixir_script/build/` directory. ElixirScript outputs JavaScript in the ES Module format. If your browser supports it, you can include the output in a script tag with the type "module"
+
+  ```html
+  <script type="module">
+    import Elixir from '/js/Elixir.App.js'
+    const myInitialArgs = []
+
+    Elixir.start(Elixir.MyEntryModule, myInitialArgs)
+  </script>
+  ```
+
+  If your browser does not yet support ES modules directly, use a tool such as [webpack](https://webpack.js.org/) or [brunch](http://brunch.io/) to convert it into something that can be used in the browser
+
+  ### JavaScript Interop
+
+  Check out the [JavaScript Interoperability](JavascriptInterop.html) documentation
+
+  ### Limitations
+
+  ElixirScript does not support `receive` or any of OTP at this time.
+  """
 end
diff --git a/mix.exs b/mix.exs
@@ -14,7 +14,8 @@ defmodule ElixirScript.Mixfile do
       aliases: aliases(),
       test_coverage: [tool: ExCoveralls],
       docs: [
-        extras: ["GettingStarted.md", "JavaScriptInterop.md"]
+        main: "ElixirScript",
+        extras: ["JavaScriptInterop.md"]
       ]
     ]
   end

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ defmodule ElixirScript.Mixfile do`
`14`	`14`	`aliases: aliases(),`
`15`	`15`	`test_coverage: [tool: ExCoveralls],`
`16`	`16`	`docs: [`
`17`		`- extras: ["GettingStarted.md", "JavaScriptInterop.md"]`
	`17`	`+ main: "ElixirScript",`
	`18`	`+ extras: ["JavaScriptInterop.md"]`
`18`	`19`	`]`
`19`	`20`	`]`
`20`	`21`	`end`