From d2ffecba2db7917b7411eca17fb9f24bfeb0f8c9 Mon Sep 17 00:00:00 2001 From: Jeremiah Senkpiel Date: Mon, 24 Aug 2015 10:29:40 -0400 Subject: [PATCH] doc: add internal modules notice MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-By: Colin Ihrig Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Michaƫl Zasso --- lib/internal/readme.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 lib/internal/readme.md diff --git a/lib/internal/readme.md b/lib/internal/readme.md new file mode 100644 index 00000000000000..38c7f6ad13b431 --- /dev/null +++ b/lib/internal/readme.md @@ -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.