Skip to content

Commit 520696a

Browse files
Better summary
1 parent d43d0d5 commit 520696a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
# Singed
22

3-
Singed makes it easy to get a flamegraph anywhere in your code base:
3+
Singed makes it easy to get a flamegraph anywhere in your code base. It wraps profiling your code with [stackprof](https://github.com/tmm1/stackprof) or [rbspy](https://github.com/rbspy/rbspy), and then launching [speedscope](https://github.com/jlfwong/speedscope) to view it.
4+
5+
## Installation
6+
7+
Add to `Gemfile`:
8+
9+
```ruby
10+
gem "singed"
11+
```
12+
13+
Then run `bundle install`
414

515
## Usage
616

7-
To profile your code, and launch [speedscope](https://github.com/jlfwong/speedscope) for viewing it:
17+
Simplest is calling with a block:
818

919
```ruby
1020
flamegraph {

0 commit comments

Comments
 (0)