Skip to content

Commit d7e27fe

Browse files
WuPengheWuPenghe
authored andcommitted
Merge branch 'master' of https://github.com/AsyncOptics/async-optics into penghe
2 parents 02b82d4 + 6cd8249 commit d7e27fe

File tree

5 files changed

+10
-19
lines changed

5 files changed

+10
-19
lines changed

README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,27 @@
1-
# AsyncOptics
2-
[![npm version](https://badge.fury.io/js/async-optics.svg)](https://badge.fury.io/js/async-optics)
3-
1+
<img src="readme/new-logo.png" width="400"/>
42

5-
<img src="readme/logo.png" width="200"/>
3+
[![npm version](https://badge.fury.io/js/async-optics.svg)](https://badge.fury.io/js/async-optics)
64

7-
AsyncOptics is an asynchronous code viewer, performance monitor, and package monitor for Node.js applications. It is able to track and monitor asynchronous functions with Node.js' Async Hooks and Perf Hooks. *The aggregated information is displayed in a Sankey diagram with hierarchical behavior for asynchronous functions and as a Sunburst graph for information of package monitoring.* The Sankey diagram handles real-time changes for live testing and allows hovering capabilities to show specific information on desired functions on a lower panel.
5+
AsyncOptics is an asynchronous code viewer, performance monitor, and package monitor for Node.js and Mongodb applications. It is able to track and monitor asynchronous processes with Node.js' Async Hooks and Perf Hooks. The aggregated information is displayed in a Sankey diagram with hierarchical behavior of asynchronous functions and as a Sunburst graph for information of package monitoring. The Sankey diagram handles real-time changes for live testing and allows hovering capabilities to show specific information on desired functions on a lower panel.
86

97
### Installation
108

119
- `npm i async-optics`
1210

1311
### How to use
1412

15-
```
13+
`
1614
const {asyncMonitor, pkgMonitor} = require('async-optics');
17-
asyncMonitor(PortNumber); // asyncMonitor(3000);
18-
pkgMonitor(complete path to package.json file); //pkgMonitor(path.join(__dirname, '../package.json'));
19-
```
15+
asyncMonitor(PortNumber); // default 3000
16+
pkgMonitor(complete path to package.json file);
17+
`
2018
- run your program, go to http://localhost:PortNumber
2119

22-
```
2320
async monitor
24-
```
25-
<img src="readme/asyncMonitor.png" width="1000"/>
21+
<img src="readme/async.gif" width="800"/>
2622

27-
```
2823
pkg monitor
29-
```
30-
<img src="readme/pkgMonitor.png" width="800"/>
24+
<img src="readme/pm.gif" width="800"/>
3125

3226

3327
## Contributing
@@ -38,10 +32,7 @@ Any suggestions are welcomed!
3832

3933
## Authors
4034

41-
* **Aleksander Turberville** - [https://github.com/Aturberv](https://github.com/Aturberv)
42-
* **Sarah Renshaw** - [https://github.com/sartra](https://github.com/sartra)
43-
* **Penghe Wu** - [https://github.com/wupenghe92](https://github.com/wupenghe92)
44-
* **Ralph Salazar** - [https://github.com/pjr4lph](https://github.com/pjr4lph)
35+
[Aleksander Turberville](https://github.com/Aturberv) | [Sarah Renshaw](https://github.com/sartra) | [Penghe Wu](https://github.com/wupenghe92) | [Ralph Salazar](https://github.com/pjr4lph)
4536

4637
## License
4738

readme/async.gif

1.78 MB
Loading

readme/logo.png

18.6 KB
Loading

readme/new-logo.png

40.8 KB
Loading

readme/pm.gif

1.01 MB
Loading

0 commit comments

Comments
 (0)