Merge pull request trenpixster#122 from eidge/patch-1

Clarifying README on route definition
meltwater · May 9, 2017 · 9271c60 · 9271c60
2 parents 5ae9622 + e9b416a
commit 9271c60
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -43,7 +43,11 @@ defmodule YourApp.Router do
   use Addict.RoutesHelper
   (...)
   scope "/" do
-    addict :routes
+    # Note that the `addict :routes` call should be inside the global
+    # scope rather than your app's scope:
+    # (i.e.: `scope "/", YourApp do: ...` vs `scope "/", do ...`)
+    # otherwise Phoenix won't be able to find Addict's controllers.
+    addict :routes
   end
 end
 ```