Update docs

bryanjos · bryanjos · commit fe5dce7d805e · 2017-04-09T11:14:26.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -64,27 +64,26 @@ found in Elixir in ElixirScript.
 ElixirScript is broken up into the following parts:
 
 * The compiler, written in Elixir
-* The standard library modules, mostly written in Elixir
+* The standard library modules, written in Elixir
 * The javascript core
 
 The ElixirScript compiler is in the `lib` folder of the project. 
 Here is where Elixir code is converted into JavaScript.
 
-The standard library modules are in the `lib/std_lib` folder.
+The standard library modules are in the `priv/std_lib` folder.
 
 The JavaScript code is in the `src/javascript`. 
-This is where features such as pattern matching and the standard library are implemented.
+This is where features such as pattern matching and the special forms are implemented.
 
 The ElixirScript tests can be run using `mix test`
 
-The JavaScript tests can be run using `npm test`
+The JavaScript tests can be run using `yarn test`
 
 Please make sure all tests pass after making changes. Also make sure to include tests for
 the changes you made.
 
-Contributing to the JavaScript code may be the easiest and most rewarding changes.
-Don't see a feature, module or function from Elixir in ElixirScript yet? You can implement it
-in the JavaScript code.
+Contributing to the standard library may be the easiest and most rewarding changes.
+Don't see a module, function or macro from Elixir in ElixirScript yet? You can help by implementing it.
 
 ## Pull requests
 
@@ -119,7 +118,7 @@ in order to craft an excellent pull request:
   # Navigate to the newly cloned directory
   cd elixirscript
   # Assign the original repo to a remote called "upstream"
-  git remote add upstream https://github.com/bryanjos/elixirscript
+  git remote add upstream https://github.com/elixirscript/elixirscript
   ```
 
 2. If you cloned a while ago, get the latest changes from upstream:
@@ -150,7 +149,7 @@ in order to craft an excellent pull request:
 
   ```sh
   mix test
-  npm test
+  yarn test
   ```
 
   This is needed to ensure your changes can
diff --git a/FAQ.md b/FAQ.md
@@ -6,77 +6,7 @@
 
 # Q. How much is implemented?
 
-### A. Most of Kernel.SpecialForms as well as some modules in the Standard Library
-
-The compiler to this point has been focused on translating Kernel.SpecialForms and Kernel. Below is a list of what is complete, incomplete, as well as missing
-
-#### Kernel.SpecialForms
-
-* Complete
-    * `__DIR__`
-    * `__MODULE__`
-    * `^var`
-    * `&expr`
-    * `for`
-    * `%{}`
-    * `{args}`
-    * `<<args>>`
-    * `fn [clauses] end`
-    * `cond(clauses)`
-    * `__block__`
-    * `__aliases__`
-    * `unquote`
-    * `unquote_splicing`
-    * `%`
-    * `left.right`
-    * `quote`
-    * `import`
-    * `case`
-    * `left = right`
-    * `require`
-    * `left :: right`
-    * `alias`
-    * `__CALLER__`
-    * `__ENV__`
-    * `super(args)`
-
-* Missing
-    * `receive`
-
-* Caveats
-    * `quote` - ignores `context` options
-    * `left = right` does not support full unification yet.
-        ```elixir
-        a = 1 # works as expected
-
-        1 = a # may not work currently, but in some cases it will
-        ```
-
-
-#### Completed Modules
-
-    * Tuple
-    * List
-    * Atom
-    * Range
-    * Map
-    * MapSet
-
-#### Incomplete Modules
-
-    * Kernel
-    * Enum
-    * Agent
-    * Integer
-    * Keyword
-    * Base
-    * String
-    * Bitwise
-    * Set
-
-#### Missing Modules
-    * Everything else
-
+### A. Check out the [Supported Modules, Functions, and Macros](Supported.md)
 
 ## Q. Can I use it today?
 
diff --git a/lib/elixir_script/gen/supported.ex b/lib/elixir_script/gen/supported.ex
@@ -29,7 +29,7 @@ defmodule ElixirScript.Gen.Supported do
     module_map = get_module_map()
 
     Enum.each(module_map, fn({elixir_module, elixir_script_module}) ->
-      IO.puts(file, "## #{inspect elixir_module}")      
+      IO.puts(file, "## #{inspect elixir_module}")   
       exports = elixir_module.__info__(:functions) ++ elixir_module.__info__(:macros)
       elixir_script_exports = if Code.ensure_loaded?(elixir_script_module) do
         elixir_script_module.__info__(:functions) ++ elixir_script_module.__info__(:macros)
diff --git a/mix.exs b/mix.exs
@@ -15,7 +15,7 @@ defmodule ElixirScript.Mixfile do
       aliases: aliases(),
       test_coverage: [tool: ExCoveralls],
       docs: [
-        extras: ["GettingStarted.md", "FAQ.md"]
+        extras: ["GettingStarted.md", "FAQ.md", "Supported.md"]
       ]
     ]
   end

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