Permalink
Browse files

stubbed readme

  • Loading branch information...
1 parent c3c42a9 commit 104d21f617af44a5a06bf9795e78f432e967440b @dannycoates dannycoates committed Dec 1, 2010
Showing with 22 additions and 0 deletions.
  1. +22 −0 readme.md
View
@@ -0,0 +1,22 @@
+v8-profiler provides [node](http://github.com/ry/node) bindings for the v8
+profiler and integration with [node-inspector](http://github.com/dannycoates/node-inspector)
+
+## Installation
+
+ npm install v8-profiler
+
+## Usage
+
+ var profiler = require('v8-profiler');
+
+## API
+
+ var snapshot = profiler.takeSnapshot([name]) //takes a heap snapshot
+
+ profiler.startProfiling([name]) //begin cpu profiling
+ var cpuProfile = profiler.stopProfiling([name]) //finish cpu profiling
+
+## node-inspector
+
+Cpu profiles can be viewed and heap snapshots may be taken and viewed from the
+profiles panel.

0 comments on commit 104d21f

Please sign in to comment.