From 63ff2ad2489e7ce1d6bba96c2c0817f1d5261be6 Mon Sep 17 00:00:00 2001 From: wille Date: Tue, 30 Jul 2024 21:50:25 +0200 Subject: [PATCH] Update README --- README.md | 5 +++++ package.json | 5 ++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc77943..2d095f0 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,11 @@ Supports "CSP Level 2 Reports" in browsers browsers not supporting the Reporting Retrofitting a policy on a large website is hard to get right first. The solution is to use `-Report-Only` policies that will not enforce them and break your website. These headers and their enforcing equivalents supports reporting, which makes all policy violations gets sent to you so you can adjust your policies to not break functionality. ### Setup a reporting endpoint and setup reporters on your policy headers + +``` +$ npm install reporting-api +``` + ```ts import { reportingEndpoint } from 'reporting-api'; import express from 'express'; diff --git a/package.json b/package.json index 235fa0d..9b0e2d6 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,10 @@ "files": [ "dist/" ], - "repository": "github:wille/reporting-api", + "repository": { + "type": "git", + "url": "git+https://github.com/wille/reporting-api.git" + }, "author": "wille", "license": "MIT", "description": "Roll your own Reporting API collector. Supports CSP, COEP, COOP, Document-Policy, Crash reports, Deprecation reports, Intervention reports and Network Error Logging ",