@wnodex/helmet 0.2.1 → 0.2.2

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 
-> @wnodex/helmet@0.2.1 build /home/runner/work/wnodex/wnodex/packages/helmet
+> @wnodex/helmet@0.2.2 build /home/runner/work/wnodex/wnodex/packages/helmet
 > rolldown -c && tsc
 
 [log] <DIR>/index.js  chunk │ size: 0.97 kB
 [log]
-[success] rolldown v1.0.0-rc.1 Finished in 4.41 ms
+[success] rolldown v1.0.0-rc.1 Finished in 13.71 ms

package/README.md

@@ -1,14 +1,75 @@
 # @wnodex/helmet
 
-wnodex helmet middleware
+> wnodex helmet middleware
 
----
+Part of the [wnodex](https://github.com/wnodex/wnodex) ecosystem, this package provides security-focused middleware using Helmet.
 
-## Table of Content
+## About
 
-- [License](#license)
+`@wnodex/helmet` integrates the `helmet` middleware to help secure your `wnodex` application by setting various HTTP headers. It provides sensible defaults to protect against common web vulnerabilities.
 
----
+## Features
+
+- Simple integration with `wnodex`.
+- Sets important security headers like `Content-Security-Policy`, `Strict-Transport-Security`, and more.
+- Configurable to disable or customize specific headers.
+- Based on the popular `helmet` library.
+
+## Why use it?
+
+Security is a primary concern for any web application. `@wnodex/helmet` makes it easy to apply a baseline of security measures with zero configuration. By managing it within `wnodex`, you ensure that security headers are applied consistently across your application.
+
+## Installation
+
+You can install the package using your favorite package manager:
+
+**pnpm**
+
+```bash
+pnpm add @wnodex/helmet
+```
+
+**npm**
+
+```bash
+npm install @wnodex/helmet
+```
+
+**yarn**
+
+```bash
+yarn add @wnodex/helmet
+```
+
+**bun**
+
+```bash
+bun add @wnodex/helmet
+```
+
+## Usage
+
+`@wnodex/helmet` is disabled by default. To enable it with default settings, set `helmet: true`. You can also pass a configuration object to customize its behavior.
+
+```typescript
+import { Wnodex } from 'wnodex';
+
+// Example: Enable Helmet with default settings
+const server = new Wnodex({
+  helmet: true,
+});
+
+// Example: Customize Helmet options
+const serverWithCustomHelmet = new Wnodex({
+  helmet: {
+    contentSecurityPolicy: false, // Disable a specific middleware
+  },
+});
+
+server.start();
+```
+
+The options object is passed directly to the `helmet` library.
 
 ## License
 

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "@wnodex/helmet",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "private": false,
-  "description": "wnodex helmet middleware",
+  "description": "A wnodex middleware that integrates Helmet to secure your application by setting various HTTP headers.",
   "keywords": [
-    "wnodex"
+    "wnodex",
+    "middleware",
+    "helmet",
+    "express",
+    "security",
+    "headers",
+    "csp"
   ],
   "homepage": "https://github.com/wnodex/wnodex#readme",
   "bugs": {
@@ -38,7 +44,7 @@
     "@types/node": "^25.0.10",
     "rolldown": "1.0.0-rc.1",
     "typescript": "5.9.2",
-    "@wnodex/typescript-config": "0.2.1"
+    "@wnodex/typescript-config": "0.2.2"
   },
   "publishConfig": {
     "access": "public"