docs update

Author: hlubek

README.md

@@ -1,6 +1,6 @@
 # devlog
 
-A lightweight, embeddable development dashboard for Go applications. Monitor logs, HTTP requests, and SQL queries all in one place with minimal setup.
+A lightweight, embeddable development dashboard for Go applications. Monitor logs, HTTP requests (client and server), and SQL queries all in one place with minimal setup.
 
 ![Screenshot of devlog dashboard](docs/screenshot.png)
 
@@ -9,12 +9,16 @@ A lightweight, embeddable development dashboard for Go applications. Monitor log
 - **Logs**: Capture and browse structured logs with filtering and detail view
 - **HTTP Client**: Monitor outgoing HTTP requests with timing, headers, and response info
 - **HTTP Server**: Track incoming HTTP requests to your application
-- **SQL**: Record database queries with timing and parameter information
-- **Low Overhead**: Designed to be lightweight enough for production use
+- **Low Overhead**: Designed to be lightweight to run in development and testing setups
 - **Easy to Integrate**: Embeds into your application with minimal configuration
-- **Auto-refresh**: All panels auto-refresh to show the latest data
+- **Realtime**: See events as they occur
 - **Clean UI**: Modern, minimalist interface with responsive design
 
+## Note
+
+Make sure to not activate `devlog` in production systems! It can expose sensible data like API tokens and other secret data in requests and responses.
+We currently do not have any protection of the dashboard handler routes in place.
+
 ## Installation
 
 ```bash
@@ -50,7 +54,10 @@ func main() {
 
 	// 3. Create a mux and mount the dashboard
 	mux := http.NewServeMux()
-	mux.Handle("/_devlog/", dlog.DashboardHandler())
+	
+	// Mount under path prefix /_devlog, so we handle the dashboard handler under this path
+	// Strip the prefix, so dashboard routes match and inform it about the path prefix to render correct URLs
+	mux.Handle("/_devlog/", http.StripPrefix("/_devlog", dlog.DashboardHandler("/_devlog")))
 
 	// 4. Add your application routes
 	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
@@ -87,7 +94,7 @@ devlog integrates with Go's `slog` package:
 dlog := devlog.New()
 
 logger := slog.New(
-    dlog.CollectSlogLogs(devlog.CollectSlogLogsOptions{
+    dlog.CollectSlogLogs(collector.CollectSlogLogsOptions{
 		Level: slog.LevelDebug, // Capture logs at debug level and above
 	}),
 )
@@ -109,14 +116,13 @@ Wrap your HTTP clients to capture outgoing requests:
 
 ```go
 // Wrap an existing client
-client := &http.Client{Timeout: 10 * time.Second}
-wrappedClient := dashboard.WrapHTTPClient(client)
-
-// Or wrap the default client
-wrappedClient := dashboard.WrapHTTPClient(nil)
+client := &http.Client{
+    Transport: dlog.CollectHTTPClient(http.DefaultTransport),
+    Timeout:   10 * time.Second,
+}
 
 // Now use the wrapped client
-resp, err := wrappedClient.Get("https://example.com")
+resp, err := client.Get("https://example.com")
 ```
 
 ### Capturing Incoming HTTP Requests
@@ -128,34 +134,22 @@ mux := http.NewServeMux()
 // Add your routes to mux...
 
 // Wrap the handler
-handler := dashboard.WrapHTTPHandler(mux)
+handler := dlog.CollectHTTPServer(mux)
 
 // Use the wrapped handler
 http.ListenAndServe(":8080", handler)
 ```
 
 ### Capturing SQL Queries
 
-Wrap your database connections to capture SQL queries:
-
-```go
-// Wrap a database connection
-db, err := dashboard.WrapDB("sqlite3", ":memory:")
-if err != nil {
-	// Handle error
-}
-
-// Now use the db as normal
-_, err = db.Exec("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)")
-```
+> Work in progress.
 
 ### Configuring the Dashboard
 
 Use options to customize the dashboard:
 
 ```go
 dashboard := devlog.NewWithOptions(devlog.Options{
-	BasePath:          "/_devlog",  // URL path for the dashboard
 	LogCapacity:       1000,        // Maximum number of log entries to keep
 	HTTPClientCapacity: 100,        // Maximum number of HTTP client requests to keep
 	HTTPServerCapacity: 100,        // Maximum number of HTTP server requests to keep
@@ -165,7 +159,7 @@ dashboard := devlog.NewWithOptions(devlog.Options{
 
 ## TODOs
 
-- [x] Use events to unify collected data in a combined view with grouping
+- [ ] Implement filtering of events
 
 ## License