@wnodex/cors 0.2.1 → 0.2.2

package/.turbo/turbo-build.log

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

package/README.md

@@ -1,14 +1,77 @@
 # @wnodex/cors
 
-wnodex cors middleware
+> wnodex cors middleware
 
----
+Part of the [wnodex](https://github.com/wnodex/wnodex) ecosystem, this package provides CORS middleware for `wnodex`.
 
-## Table of Content
+## About
 
-- [License](#license)
+`@wnodex/cors` integrates the `cors` middleware to enable Cross-Origin Resource Sharing (CORS) in your `wnodex` application. It allows you to control which origins can access your API.
 
----
+## Features
+
+- Enable and configure CORS from the main `wnodex` configuration.
+- Fine-grained control over `origin`, `methods`, `allowedHeaders`, and other CORS options.
+- Uses the battle-tested `cors` library for Express.
+
+## Why use it?
+
+This package provides a standardized way to manage CORS settings within a `wnodex` project. It helps prevent common cross-origin issues during development and allows you to enforce strict security policies in production, all from one central configuration point.
+
+## Installation
+
+You can install the package using your favorite package manager:
+
+**pnpm**
+
+```bash
+pnpm add @wnodex/cors
+```
+
+**npm**
+
+```bash
+npm install @wnodex/cors
+```
+
+**yarn**
+
+```bash
+yarn add @wnodex/cors
+```
+
+**bun**
+
+```bash
+bun add @wnodex/cors
+```
+
+## Usage
+
+`@wnodex/cors` is enabled by default with sensible settings for development. You can customize its behavior by passing a `cors` object to the `Wnodex` constructor.
+
+To disable it, set `cors` to `false`.
+
+```typescript
+import { Wnodex } from 'wnodex';
+
+// Example: Customize allowed origins
+const server = new Wnodex({
+  cors: {
+    origin: 'https://my-frontend-app.com',
+    methods: ['GET', 'POST'],
+  },
+});
+
+// Example: Disable CORS
+const serverWithDisabledCors = new Wnodex({
+  cors: false,
+});
+
+server.start();
+```
+
+The options object is passed directly to the `cors` library.
 
 ## License
 

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@wnodex/cors",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "private": false,
-  "description": "wnodex cors middleware",
+  "description": "A wnodex middleware that integrates CORS to enable Cross-Origin Resource Sharing.",
   "keywords": [
-    "wnodex"
+    "wnodex",
+    "middleware",
+    "cors",
+    "express",
+    "security",
+    "origin"
   ],
   "homepage": "https://github.com/wnodex/wnodex#readme",
   "bugs": {
@@ -39,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"