chore: README (#10)

.github/workflows/build.yml

@@ -3,8 +3,14 @@ name: Build binary
 on:
   push:
     branches: [ "main" ]
+    paths:
+      - '**'
+      - '!README.md'
   pull_request:
     branches: [ "main" ]
+    paths:
+      - '**'
+      - '!README.md'
   workflow_dispatch:
 
 jobs:

.github/workflows/test-go.yml

@@ -6,11 +6,13 @@ on:
     paths:
       - '**'
       - '!ts/**'
+      - '!README.md'
   pull_request:
     branches: [ "main" ]
     paths:
       - '**'
       - '!ts/**'
+      - '!README.md'
   workflow_dispatch:
 
 jobs:

README.md

@@ -1,10 +1,38 @@
+<img width="1920" alt="Xnip2024-09-05_22-25-31" src="https://github.com/user-attachments/assets/fee917b2-8bc6-47e5-8b18-47bd56c545a5">
+
 You don’t want to clutter up your computer with Docker, Prometheus, Grafana or even K8S just to monitor a Go app's heap size in real-time, right?
 
 Use `live-pprof` to Monitor a Go app's performance. It launches in just 1 second. Boost your local development now.
 
 ## Install
+
 ```bash
 go install github.com/moderato-app/live-pprof
 ```
 
-<img width="1920" alt="Xnip2024-09-05_22-25-31" src="https://github.com/user-attachments/assets/fee917b2-8bc6-47e5-8b18-47bd56c545a5">
+## Usage
+
+1. Setup pprof endpoints
+
+```bash
+package main
+
+import (
+	"log"
+	"net/http"
+	_ "net/http/pprof"
+)
+
+func main() {
+	log.Println(http.ListenAndServe("localhost:6060", nil))
+}
+```
+
+2. Monitor the pprof endpoints
+
+```bash
+live-pprof 6060 
+# Or use:
+live-pprof http://localhost:6060/debug/pprof
+# Both options will monitor http://localhost:6060/debug/pprof
+```