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.