From 4d8ad703cc76078bd383bda83703f8d2f58d729e Mon Sep 17 00:00:00 2001 From: Phil Ricketts <812139+replete@users.noreply.github.com> Date: Fri, 20 Sep 2024 18:17:20 +0100 Subject: [PATCH] Update README --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 30e673f..d2ddc1f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # biscuitman.js 🍪 Lightweight Consent Manager ![tests](https://github.com/replete/biscuitman/actions/workflows/node.js.yml/badge.svg) -![screenshot of main UI](media/ui.webp) +Biscuitman is a super lightweight, customizable consent manager for your website. Weighing in around 3-4kB compressed, its designed to be fast-loading and easy to implement with a flat configuration object. +![screenshot of main UI](media/ui.webp) #### [View demo](https://replete.github.io/biscuitman) -100kB+ seemed too heavy for a cookie popup so I wrote this, it's around 4kB compressed including CSS, designed to be as small as possible and versatile enough for basic website 'cookie' consent management. +## Features overview - Stores consent in `localStorage`, exposes in `window.Consent` and through custom events fired on `document` - Handles consent granulated by custom sections (e.g. essential, performance, analytics...) - Optionally shows user specific cookie (or localStorage item) details @@ -16,12 +17,13 @@ - Simple flat configuration object - Injects scripts when granular consent is granted (``) - Injects embedded 'after' `