aboutsummaryrefslogtreecommitdiff
path: root/node_modules/chrome-trace-event/README.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/chrome-trace-event/README.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/chrome-trace-event/README.md')
-rw-r--r--node_modules/chrome-trace-event/README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/node_modules/chrome-trace-event/README.md b/node_modules/chrome-trace-event/README.md
new file mode 100644
index 00000000..8bd20774
--- /dev/null
+++ b/node_modules/chrome-trace-event/README.md
@@ -0,0 +1,31 @@
+[![Build Status](https://travis-ci.org/samccone/chrome-trace-event.svg?branch=master)](https://travis-ci.org/samccone/chrome-trace-event)
+
+chrome-trace-event: A node library for creating trace event logs of program
+execution according to [Google's Trace Event
+format](https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU).
+These logs can then be visualized with
+[trace-viewer](https://github.com/google/trace-viewer) or chrome devtools to grok one's programs.
+
+# Install
+
+ npm install chrome-trace-event
+
+# Usage
+
+```javascript
+const Trace = require("chrome-trace-event").Tracer;
+const trace = new Trace({
+ noStream: true
+});
+trace.pipe(fs.createWriteStream(outPath));
+trace.flush();
+```
+
+# Links
+
+* https://github.com/google/trace-viewer/wiki
+* https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU
+
+# License
+
+MIT. See LICENSE.txt.