added info about routes in local env

dedoc · Jul 30, 2023 · bc7811c · bc7811c
1 parent 188f074
commit bc7811c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -33,6 +33,8 @@ After install you will have 2 routes added to your application:
 - `/docs/api` - UI viewer for your documentation
 - `/docs/api.json` - Open API document in JSON format describing your API.
 
+By default, these routes are available only in `local` environment. You can change this behavior by defining `viewApiDocs` gate.
+
 ---
 
 <p>

diff --git a/docs/installation.md b/docs/installation.md
@@ -18,7 +18,9 @@ When Scramble is installed, 2 routes are added to your application:
 - `/docs/api` - UI viewer for your documentation
 - `/docs/api.json` - Open API document in JSON format describing your API.
 
-And that's it! You can now visit `/docs/api` to see your API documentation.
+And that's it! You can now visit `/docs/api` to see your API documentation. 
+
+By default, these routes are available only in `local` environment. You can change this behavior by defining `viewApiDocs` gate.
 
 ## Models attributes support
-Original file line number
+Diff line change
@@ Expand Up @@
     - `/docs/api` - UI viewer for your documentation
     - `/docs/api.json` - Open API document in JSON format describing your API.
+    By default, these routes are available only in `local` environment. You can change this behavior by defining `viewApiDocs` gate.
     ---
     <p>
@@ Expand Down @@