From 542e795fe0b5f6ac8cc79ece4e639be57150f97f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 23 May 2014 22:56:56 +0800 Subject: [PATCH] :memo: Mention atom-shell's changes to the process object. --- docs/README.md | 1 + docs/api/process.md | 8 ++++++++ 2 files changed, 9 insertions(+) create mode 100644 docs/api/process.md diff --git a/docs/README.md b/docs/README.md index 99ad1a5f2a22..82ab7c5228b8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,6 +7,7 @@ ## API references * [Synopsis](api/synopsis.md) +* [Process object](api/process.md) Modules for browser side: diff --git a/docs/api/process.md b/docs/api/process.md new file mode 100644 index 000000000000..31fb95ce3523 --- /dev/null +++ b/docs/api/process.md @@ -0,0 +1,8 @@ +# Process object + +The `process` object in atom-shell has following differences between the one in +upstream node: + +* `process.type` String - Process's type, can be `browser` or `renderer`. +* `process.versions['atom-shell']` String - Version of atom-shell. +* `process.resourcesPath` String - Path to JavaScript source codes.