Skip to content

Commit

Permalink
updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
saquibkhan committed Jul 13, 2020
1 parent 760359b commit 7b3a934
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
#FlameGraph for Java - An Easy way to quickly create flamegraphs for Java.
# FlameGraph for Java - An Easy way to quickly create flamegraphs for Java.

#Installation
# Installation
```npm install javaflamegraph```

#Usage
# Usage
1. ```cd ./node_modules/javaflamegraph```
2. ```npm start``` - This will wait till it detects a process with name 'Java'. Can be best best used to start profiling at program startup.
3. ```npm run start <process id>``` - This will start profiling for the given process id.
e.g. ```npm run start 1234```

#Dependency
# Dependency
This library depends on perl, shell, and jstack (Java SDK).These are already available on linux/mac.On windows you can use this package with cygwin.

##Acknowledgements
## Acknowledgements
Thanks to [Brendan Gregg's FlameGraph](https://github.com/brendangregg/FlameGraph)

## License
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@saquibkhan/javaflamegraph",
"version": "1.0.0",
"version": "1.0.1",
"description": "FlameGraph for Java",
"main": "",
"scripts": {
Expand Down

0 comments on commit 7b3a934

Please sign in to comment.