kaelum 1.3.2 → 1.3.3

package/README.md

@@ -1,8 +1,15 @@
 # Kaelum
 
+[![npm version](https://img.shields.io/npm/v/kaelum)](https://www.npmjs.com/package/kaelum)
+[![Build Status](https://github.com/MatheusCampagnolo/kaelum/actions/workflows/deploy-docs.yml/badge.svg)](https://github.com/MatheusCampagnolo/kaelum/actions)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-online-blue)](https://matheuscampagnolo.github.io/kaelum/)
+
 **Kaelum.JS** — Minimalist Node.js framework to simplify creation of web pages and REST APIs.  
 Designed for students and developers who want a fast, opinionated project scaffold and a small, friendly API that encapsulates common Express.js boilerplate.
 
+👉 [**Read the full documentation here**](https://matheuscampagnolo.github.io/kaelum/)
+
 ---
 
 ## 🚀 Quick start
@@ -11,7 +18,7 @@ Create a new project (interactive):
 
 ```bash
 npx kaelum create
-````
+```
 
 Or create non-interactively (project name + template):
 
@@ -35,13 +42,14 @@ npm start
 
 ## 📦 What Kaelum provides
 
-* CLI that scaffolds a ready-to-run project (Web or API template) using an opinionated **MVC** structure.
-* Thin abstraction layer over **Express.js** that:
+- CLI that scaffolds a ready-to-run project (Web or API template) using an opinionated **MVC** structure.
+- Thin abstraction layer over **Express.js** that:
 
-  * automates JSON / URL-encoded parsing by default,
-  * automatically configures common security middlewares via `setConfig` (CORS, Helmet),
-  * exposes a small, easy-to-learn API for routes, middleware and configuration.
-* Small set of helpers for common tasks: `start`, `addRoute`, `apiRoute`, `setConfig`, `static`, `redirect`, `healthCheck`, `useErrorHandler`, and more.
+  - automates JSON / URL-encoded parsing by default,
+  - automatically configures common security middlewares via `setConfig` (CORS, Helmet),
+  - exposes a small, easy-to-learn API for routes, middleware and configuration.
+
+- Small set of helpers for common tasks: `start`, `addRoute`, `apiRoute`, `setConfig`, `static`, `redirect`, `healthCheck`, `useErrorHandler`, and more.
 
 Kaelum aims to reduce the initial setup burden while keeping flexibility for advanced users.
 
@@ -49,7 +57,7 @@ Kaelum aims to reduce the initial setup burden while keeping flexibility for adv
 
 ## 📁 Template structures
 
-### Web template (created by `npx kaelum create <name>` with template `web`)
+### Web template (`--template web`)
 
 ```
 my-web-app/
@@ -81,12 +89,12 @@ my-api-app/
 
 ---
 
-## 🧩 Core API (examples — CommonJS)
+## 🧩 Core API
 
 > Kaelum exposes a factory — use `require('kaelum')` and call it to get an app instance:
 
 ```js
-const kaelum = require('kaelum');
+const kaelum = require("kaelum");
 const app = kaelum();
 ```
 
@@ -96,17 +104,17 @@ Enable/disable common features:
 
 ```js
 app.setConfig({
-  cors: true,         // apply CORS (requires cors package in dependencies)
-  helmet: true,       // apply Helmet
-  static: "public",   // serve static files from "public"
-  bodyParser: true,   // default: enabled (JSON + urlencoded)
-  logs: false,        // enable request logging via morgan (if installed)
-  port: 3000          // prefered port (used when calling app.start() without port)
+  cors: true, // apply CORS (requires cors package in dependencies)
+  helmet: true, // apply Helmet
+  static: "public", // serve static files from "public"
+  bodyParser: true, // default: enabled (JSON + urlencoded)
+  logs: false, // enable request logging via morgan (if installed)
+  port: 3000, // prefered port (used when calling app.start() without port)
 });
 ```
 
-* `setConfig` persists settings to the Kaelum config and will install/remove Kaelum-managed middlewares.
-* Kaelum enables JSON/urlencoded parsing by default so beginners won't forget to parse request bodies.
+- `setConfig` persists settings to the Kaelum config and will install/remove Kaelum-managed middlewares.
+- Kaelum enables JSON/urlencoded parsing by default so beginners won't forget to parse request bodies.
 
 ---
 
@@ -115,7 +123,7 @@ app.setConfig({
 Starts the HTTP server. If `port` is omitted, Kaelum reads `port` from `setConfig` or falls back to `3000`.
 
 ```js
-app.start(3000, () => console.log('Running'));
+app.start(3000, () => console.log("Running"));
 ```
 
 ---
@@ -125,20 +133,20 @@ app.start(3000, () => console.log('Running'));
 Register routes easily:
 
 ```js
-app.addRoute('/home', {
-  get: (req, res) => res.send('Welcome!'),
-  post: (req, res) => res.send('Posted!')
+app.addRoute("/home", {
+  get: (req, res) => res.send("Welcome!"),
+  post: (req, res) => res.send("Posted!"),
 });
 
 // apiRoute builds RESTy resources with nested subpaths:
-app.apiRoute('users', {
+app.apiRoute("users", {
   get: listUsers,
   post: createUser,
-  '/:id': {
+  "/:id": {
     get: getUserById,
     put: updateUser,
-    delete: deleteUser
-  }
+    delete: deleteUser,
+  },
 });
 ```
 
@@ -152,13 +160,13 @@ Flexible helper to register middleware(s):
 
 ```js
 // single middleware
-app.setMiddleware(require('helmet')());
+app.setMiddleware(require("helmet")());
 
 // array of middlewares
 app.setMiddleware([mw1, mw2]);
 
 // mount middleware on a path
-app.setMiddleware('/admin', authMiddleware);
+app.setMiddleware("/admin", authMiddleware);
 ```
 
 ---
@@ -168,7 +176,7 @@ app.setMiddleware('/admin', authMiddleware);
 Register a redirect route:
 
 ```js
-app.redirect('/old-url', '/new-url', 302);
+app.redirect("/old-url", "/new-url", 302);
 ```
 
 ---
@@ -193,45 +201,42 @@ It will return standardized JSON for errors and log server-side errors (5xx) to
 
 ## 🔧 Local development & contributing
 
-To develop Kaelum locally and test the CLI:
-
 ```bash
-# clone
 git clone https://github.com/MatheusCampagnolo/kaelum.git
 cd kaelum
-
-# install & link locally
 npm install
 npm link
+```
+
+Now you can test the CLI locally:
 
-# from any folder you can now run the CLI
+```bash
 npx kaelum create my-test --template web
-# or
-kaelum create my-test    # if linked globally
 ```
 
 ---
 
-
 ## 📝 Why Kaelum?
 
-* Reduces repetitive boilerplate required to start Node/Express web projects.
-* Opinionated scaffolding (MVC) helps beginners adopt better structure.
-* Keeps a small API surface: easy to teach and document.
-* Extensible — `setConfig` and middleware helpers allow adding features without exposing Express internals.
+- Reduces repetitive boilerplate required to start Node/Express web projects.
+- Opinionated scaffolding (MVC) helps beginners adopt better structure.
+- Keeps a small API surface: easy to teach and document.
+- Extensible — `setConfig` and middleware helpers allow adding features without exposing Express internals.
 
 ---
 
 ## ✅ Current status
 
-> Kaelum is under active development. The CLI scaffolds web and API templates and the framework already includes the MVP helpers (`start`, `addRoute`, `apiRoute`, `setConfig`, `static`, `redirect`, `healthCheck`, `useErrorHandler`) and security toggles for `cors` and `helmet`.
+> Kaelum is under active development.
+> CLI scaffolds web and API templates, and the framework includes the MVP helpers (`start`, `addRoute`, `apiRoute`, `setConfig`, `static`, `redirect`, `healthCheck`, `useErrorHandler`) and security toggles for `cors` and `helmet`.
 
 ---
 
 ## 📚 Links
 
-* GitHub: `https://github.com/MatheusCampagnolo/kaelum`
-* npm: `https://www.npmjs.com/package/kaelum`
+- [GitHub](https://github.com/MatheusCampagnolo/kaelum)
+- [npm](https://www.npmjs.com/package/kaelum)
+- [Documentation](https://matheuscampagnolo.github.io/kaelum/)
 
 ---
 
@@ -243,6 +248,5 @@ MIT — see [LICENSE](LICENSE).
 
 ## ✍️ Notes for maintainers
 
-* Templates include `package.json` configured as `commonjs` for now (uses `require`/`module.exports`).
-* Update template `package.json` dependencies to reference Kaelum version when releasing new npm versions.
-* We plan to add full JSDoc for the public API, unit tests (Jest + Supertest) and a docs site in future iterations.
+- Templates use `commonjs` (`require` / `module.exports`).
+- Update template dependencies to reference the correct Kaelum version when releasing new npm versions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kaelum",
-  "version": "1.3.2",
+  "version": "1.3.3",
   "description": "A minimalist Node.js framework for building web pages and APIs with simplicity and speed.",
   "main": "index.js",
   "exports": {