Add documentation

Author: bryanjos

lib/react.ex

@@ -1,5 +1,19 @@
 defmodule React do
+  @moduledoc """
+  FFI Module for interacting with the React
+  JavaScript module.
+  """
   use ElixirScript.FFI
 
+  @doc """
+  Creates a React Element
+
+  ```elixir
+  props = ElixirScript.JS.map_to_object(%{"hello" => world})
+  children = []
+
+  React.createElement("div", props, children)
+  ```
+  """
   defexternal createElement(type, props, children)
 end

lib/react_dom.ex

@@ -1,5 +1,19 @@
 defmodule ReactDOM do
+  @moduledoc """
+  FFI Module for interacting with the ReactDOM
+  JavaScript module.
+  """
   use ElixirScript.FFI
 
+
+  @doc """
+  Renders a React Element to the given DOM container
+
+  ```elixir
+  ReactDOM.render(my_react_element, "#my_container")
+  ```
+
+  Container is any value allowed by [document.querySelector](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector)
+  """
   defexternal render(element, container)
 end

mix.exs

@@ -22,18 +22,19 @@ defmodule ElixirScriptReact.Mixfile do
   defp deps do
     [
       {:elixir_script, "~> 0.30"},
+      {:ex_doc, "~> 0.16", only: :dev}
     ]
   end
 
   defp description do
     """
-    React Library for ElixirScript
+    React library for ElixirScript
     """
   end
 
   defp package do
     [
-      files: ["lib", "priv/**/*.*", "mix.exs", "README.md", "LICENSE", "CHANGELOG.md"],
+      files: ["lib", "priv/**/*.*", "mix.exs", "README.md"],
       maintainers: ["Bryan Joseph"],
       licenses: ["MIT"],
       links: %{

mix.lock

@@ -1,3 +1,5 @@
-%{"elixir_script": {:hex, :elixir_script, "0.30.0", "c67b2d9b6cdfa432717f4bffa3f31f476ff5c5bf15cef59142c6a85e7089d530", [:mix], [{:estree, "~> 2.6", [hex: :estree, repo: "hexpm", optional: false]}], "hexpm"},
+%{"earmark": {:hex, :earmark, "1.2.3", "206eb2e2ac1a794aa5256f3982de7a76bf4579ff91cb28d0e17ea2c9491e46a4", [], [], "hexpm"},
+  "elixir_script": {:hex, :elixir_script, "0.30.0", "c67b2d9b6cdfa432717f4bffa3f31f476ff5c5bf15cef59142c6a85e7089d530", [:mix], [{:estree, "~> 2.6", [hex: :estree, repo: "hexpm", optional: false]}], "hexpm"},
   "estree": {:hex, :estree, "2.6.0", "86a301b0c355fa55c19e7ef9dceb1b1e983c6df526a2b7846818a38c258fc3fb", [], [], "hexpm"},
+  "ex_doc": {:hex, :ex_doc, "0.16.2", "3b3e210ebcd85a7c76b4e73f85c5640c011d2a0b2f06dcdf5acdb2ae904e5084", [], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
   "fs": {:hex, :fs, "3.4.0", "6d18575c250b415b3cad559e6f97a4c822516c7bc2c10bfbb2493a8f230f5132", [], [], "hexpm"}}