docs: Added docs about dead code elimination

halfzebra · Oct 28, 2017 · a7493be · a7493be
1 parent d5fd36f
commit a7493be
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/template/README.md b/template/README.md
@@ -20,6 +20,7 @@ You can find the most recent version of this guide [here](https://github.com/hal
     - [make](#make)
     - [reactor](#reactor)
 - [Turning on/off Elm Debugger](#turning-onoff-elm-debugger)
+- [Dead code elimination](#dead-code-elimination)
 - [Changing the Page `<title>`](#changing-the-page-title)
 - [Adding a Stylesheet](#adding-a-stylesheet)
 - [Post-Processing CSS](#post-processing-css)
@@ -168,6 +169,12 @@ By default, in production (`elm-app build`) the Debugger is turned off and in de
 
 To turn on/off Elm Debugger explicitly, set `ELM_DEBUGGER` environment variable to `true` or `false` respectively.
 
+## Dead code elimination
+
+Create Elm App comes with an opinionated setup for dead code elimination which is disabled by default, because it may break your code.
+
+You can enable it by setting `DEAD_CODE_ELIMINATION` environment variable to `true`
+
 ## Changing the base path of the assets in the HTML
 
 By default, assets will be linked from the HTML to the root url. For example `/css/style.css`.