You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-6Lines changed: 30 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,26 +10,50 @@
10
10
11
11
Determine in realtime what's happening inside your node process from the terminal. No need to instrument code to get the deets. Also splits stderr/stdout to help spot errors sooner.
12
12
13
+
## Getting Started
14
+
13
15
### Install
16
+
The preferred method is global install but can optionally be placed locally as well.
17
+
18
+
`npm install -g nodejs-dashboard`
14
19
15
-
`npm install nodejs-dashboard --save-dev`
16
20
17
21
#### Add the reporting module to your code
18
22
19
-
From within your `index.js` or app entry point simply require the `nodejs-dashboard` module.
23
+
There are a couple patterns for including `nodejs-dashboard` in your code. Since this module isn't designed for production use it's best to conditionally include.
24
+
25
+
##### Including via preload argument
26
+
27
+
This pattern requires you to use a run-time flag (see below).
##### But I want to use something else to launch my app!
48
72
49
-
Most CLI interfaces provide a mechanism for launching other tools. If you're looking to use something like [nodemon](https://github.com/remy/nodemon) or [babel](https://github.com/babel/babel/tree/master/packages/babel-cli) checkout the exec options provided by the cli.
73
+
Most CLI interfaces provide a mechanism for launching other tools. If you're looking to use something like [nodemon](https://github.com/remy/nodemon) or [babel](https://github.com/babel/babel/tree/master/packages/babel-cli) checkout the exec options provided by the CLI.
0 commit comments