@fogg/bug-reporter 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -50,6 +50,36 @@ Enable these flags in config to attach logs and request traces to each report:
50
50
  />
51
51
  ```
52
52
 
53
+ ## S3 Storage Example
54
+
55
+ Use this when your backend returns presigned upload URLs.
56
+
57
+ ```tsx
58
+ import { BugReporter } from "@fogg/bug-reporter";
59
+ import "@fogg/bug-reporter/styles.css";
60
+
61
+ export function App() {
62
+ return (
63
+ <BugReporter
64
+ config={{
65
+ apiEndpoint: "https://api.example.com/bug-reports",
66
+ projectId: "web-app",
67
+ environment: "production",
68
+ storage: {
69
+ mode: "s3-presigned",
70
+ s3: {
71
+ presignEndpoint: "https://api.example.com/bug-assets/presign",
72
+ publicBaseUrl: "https://cdn.example.com"
73
+ }
74
+ }
75
+ }}
76
+ />
77
+ );
78
+ }
79
+ ```
80
+
81
+ See `docs/backend-s3.md` for the backend request/response contract.
82
+
53
83
  ## Docs
54
84
 
55
85
  - `docs/quickstart.md`