doc: add internal modules notice
authorJeremiah Senkpiel <fishrock123@rocketmail.com>
Mon, 24 Aug 2015 14:29:40 +0000 (10:29 -0400)
committerJeremiah Senkpiel <fishrock123@rocketmail.com>
Tue, 25 Aug 2015 15:58:50 +0000 (11:58 -0400)
Explicitly note that these modules should not be used outside of core.

PR-URL: https://github.com/nodejs/node/pull/2523
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaƫl Zasso <mic.besace@gmail.com>
lib/internal/readme.md [new file with mode: 0644]

diff --git a/lib/internal/readme.md b/lib/internal/readme.md
new file mode 100644 (file)
index 0000000..38c7f6a
--- /dev/null
@@ -0,0 +1,4 @@
+# Internal Modules
+
+The modules in `lib/internal` are intended for internal use in Node.js core only, and are not accessible with `require()` from user modules.
+These are subject to change at **any** time. Reliance on these modules outside of core is **not supported** in any way.