diff options
| author | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2015-08-24 17:29:40 +0300 |
|---|---|---|
| committer | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2015-08-25 18:58:50 +0300 |
| commit | 8cdac78bdf2b07b3aea92297e659cc09fca37258 (patch) | |
| tree | 93373e5ee787bcc543907749d391a85e29ad56a9 /lib/internal/readme.md | |
| parent | 7e63eb7762309487b6681ebff7f24b9fa6f40637 (diff) | |
doc: add internal modules notice
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>
Diffstat (limited to 'lib/internal/readme.md')
| -rw-r--r-- | lib/internal/readme.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/internal/readme.md b/lib/internal/readme.md new file mode 100644 index 00000000000..38c7f6ad13b --- /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. |