diff --git a/README.md b/README.md index 6faa6a0..fd5bc6b 100644 --- a/README.md +++ b/README.md @@ -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 ``` - 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 diff --git a/package.json b/package.json index aea0e6a..b8b7eb8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@saquibkhan/javaflamegraph", - "version": "1.0.0", + "version": "1.0.1", "description": "FlameGraph for Java", "main": "", "scripts": {