summaryrefslogtreecommitdiffstats
path: root/node_modules/pstree.remy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/pstree.remy/README.md')
-rw-r--r--node_modules/pstree.remy/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/node_modules/pstree.remy/README.md b/node_modules/pstree.remy/README.md
new file mode 100644
index 0000000..5f44c62
--- /dev/null
+++ b/node_modules/pstree.remy/README.md
@@ -0,0 +1,26 @@
+# pstree.remy
+
+> Cross platform ps-tree (including unix flavours without ps)
+
+## Installation
+
+```shel
+npm install pstree.remy
+```
+
+## Usage
+
+```js
+const psTree = psTree require('pstree.remy');
+
+psTree(PID, (err, pids) => {
+ if (err) {
+ console.error(err);
+ }
+ console.log(pids)
+});
+
+console.log(psTree.hasPS
+ ? "This platform has the ps shell command"
+ : "This platform does not have the ps shell command");
+```