docs(project): add description property

men232 · men232 · commit 0b0b35b8ec20 · 2025-06-15T18:25:33.000+02:00
diff --git a/packages/binlog/README.md b/packages/binlog/README.md
@@ -1,8 +1,8 @@
 # Binlog
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fbinlog) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fbinlog) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fbinlog) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fbinlog)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fbinlog)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fbinlog)
 
 A high-performance binary logging system for Node.js applications, inspired by VK's KPHP KDB binlog implementation. This library provides a robust, efficient way to record and replay binary log entries with integrity checking and rotation support.
 
diff --git a/packages/binlog/package.json b/packages/binlog/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/binlog",
+  "description": "A high-performance binary logging system for Node.js applications.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/context/README.md b/packages/context/README.md
@@ -1,8 +1,8 @@
-# Context Toolkit <!-- omit in toc -->
+# Context Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fcontext) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fcontext) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fcontext) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fcontext)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fcontext)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fcontext)
 
 A lightweight toolkit to bind asynchronous contexts, inspired by Vue's Composition API. Easily provide and inject values across asynchronous scopes with support for scoped disposal.
 
diff --git a/packages/context/package.json b/packages/context/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/context",
+  "description": "Like composition api but for Node.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,8 +1,8 @@
-# Toolkit <!-- omit in toc -->
+# Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Ftoolkit) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Ftoolkit) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Ftoolkit) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Ftoolkit)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Ftoolkit)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Ftoolkit)
 
 A personal collection of utility JavaScript functions that have been developed and refined over the years. This toolkit contains a variety of helper functions aimed at making everyday JavaScript tasks easier, more efficient, and maintainable.
 
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/toolkit",
+  "description": "General utility functions",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/dom/README.md b/packages/dom/README.md
@@ -1,8 +1,8 @@
-# DOM Toolkit <!-- omit in toc -->
+# DOM Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fdom) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fdom) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fdom) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fdom)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fdom)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fdom)
 
 This package provides a set of utility functions for common DOM tasks, including handling animations, clipboard operations, and smooth scrolling. These utilities simplify JavaScript development, making it easier to implement dynamic, interactive features while improving performance and user experience.
 
diff --git a/packages/dom/package.json b/packages/dom/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/dom",
+  "description": "Utility functions to simplify animations, clipboard operations, and smooth scrolling.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/graceful/README.md b/packages/graceful/README.md
@@ -1,8 +1,8 @@
-# Graceful Shutdown Toolkit <!-- omit in toc -->
+# Graceful Shutdown Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fgraceful) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fgraceful) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fgraceful) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fgraceful)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fgraceful)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fgraceful)
 
 This package helps gracefully shut down applications by managing dependencies during the shutdown process. It ensures that important cleanup tasks, such as closing database connections or stopping services, are completed before the application exits.
 
diff --git a/packages/graceful/package.json b/packages/graceful/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/graceful",
+  "description": "Utility to manage application shutdown.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/ioc/README.md b/packages/ioc/README.md
@@ -1,8 +1,8 @@
-# Inversion of Control (IoC) Toolkit <!-- omit in toc -->
+# Inversion of Control (IoC) Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fioc) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fioc) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fioc) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fioc)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fioc)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fioc)
 
 A simple and flexible Inversion of Control (IoC) container to help set up and manage services in your application. This toolkit automates the process of importing and registering services, ensuring that dependencies are injected properly before running your application code.
 
diff --git a/packages/ioc/package.json b/packages/ioc/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/ioc",
+  "description": "Pretty simple IOC Container.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/mongo-pagination/README.md b/packages/mongo-pagination/README.md
@@ -1,8 +1,8 @@
-# Mongo Pagination Toolkit <!-- omit in toc -->
+# Mongo Pagination Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fmongo-pagination) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fmongo-pagination) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fmongo-pagination) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fmongo-pagination)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fmongo-pagination)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fmongo-pagination)
 
 This package provides an efficient and customizable way to handle pagination for MongoDB and Mongoose queries. It simplifies working with large datasets by enabling cursor pagination, handling sorting, and managing tokens for navigating between pages.
 
diff --git a/packages/mongo-pagination/package.json b/packages/mongo-pagination/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/mongo-pagination",
+  "description": "Manages pagination without relying on traditional offsets.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/mongo-transaction/README.md b/packages/mongo-transaction/README.md
@@ -1,8 +1,8 @@
-# Mongo Transaction Toolkit <!-- omit in toc -->
+# Mongo Transaction Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fmongo-transaction) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fmongo-transaction) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fmongo-transaction) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fmongo-transaction)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fmongo-transaction)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fmongo-transaction)
 
 This package solves a common issue with MongoDB's `session.withTransaction`, where the provided function might be executed multiple times due to retries. This can create challenges for managing side effects that need to be rolled back consistently during transaction retries or failures.
 
diff --git a/packages/mongo-transaction/package.json b/packages/mongo-transaction/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/mongo-transaction",
+  "description": "Manages side effects in MongoDB transactions, rollback on failure and preventing duplicates on retries.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/pino-pretty/README.md b/packages/pino-pretty/README.md
@@ -1,7 +1,7 @@
 # Pino Pretty
 
-![license](https://img.shields.io/npm/l/@andrew_l/pino-pretty)
-![npm version](https://img.shields.io/npm/v/@andrew_l/pino-pretty)
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fpino-pretty)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fpino-pretty)
 
 A highly customizable [pino](https://www.npmjs.com/package/pino) transport that transforms JSON logs into beautiful, readable output with colors, icons, and intelligent formatting for development.
 
diff --git a/packages/search-query-language/README.md b/packages/search-query-language/README.md
@@ -1,8 +1,8 @@
-# Search Query Language <!-- omit in toc -->
+# Search Query Language
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fsearch-query-language) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fsearch-query-language) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fsearch-query-language) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fsearch-query-language)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fsearch-query-language)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fsearch-query-language)
 
 Search Query Language is a lightweight utility that converts human-readable query strings into structured representations. It supports parsing expressions into an abstract syntax tree (AST) and transforming them into queries.
 
diff --git a/packages/search-query-language/package.json b/packages/search-query-language/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/search-query-language",
+  "description": "Converts human-readable query strings into structured representations.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/service-actor/README.md b/packages/service-actor/README.md
@@ -1,8 +1,8 @@
-# Service Actor Toolkit <!-- omit in toc -->
+# Service Actor Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fservice-actor) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fservice-actor) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fservice-actor) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fservice-actor)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fservice-actor)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fservice-actor)
 
 The package is designed to help manage contextual data, such as trace IDs, across functions without explicitly passing them around. This allows you to easily track and manage contexts (like user actions or requests) while keeping your code clean and decoupled from context-passing logic.
 
diff --git a/packages/service-actor/package.json b/packages/service-actor/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/service-actor",
+  "description": "Forget about passing data like trace IDs between functions.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/tl-pack/README.md b/packages/tl-pack/README.md
@@ -1,8 +1,8 @@
-# TL Pack - Binary Serialization Library <!-- omit in toc -->
+# TL Pack - Binary Serialization Library
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Ftl-pack) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Ftl-pack) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Ftl-pack) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Ftl-pack)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Ftl-pack)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Ftl-pack)
 
 Binary serialization library, inspired by the TL (Type Language) format, created by the VK team. Unlike official TL, this version does not require a schema for serialization/deserialization. It provides a compact and fast alternative to other binary serialization formats like MessagePack.
 
diff --git a/packages/tl-pack/package.json b/packages/tl-pack/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/tl-pack",
+  "description": "Another implementation of binary serialization.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",
diff --git a/packages/vue-stdout/README.md b/packages/vue-stdout/README.md
@@ -1,8 +1,8 @@
-# Vue Stdout Toolkit <!-- omit in toc -->
+# Vue Stdout Toolkit
 
-![license](https://img.shields.io/npm/l/%40andrew_l%2Fvue-stdout) <!-- omit in toc -->
-![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fvue-stdout) <!-- omit in toc -->
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fvue-stdout) <!-- omit in toc -->
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fvue-stdout)
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fvue-stdout)
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fvue-stdout)
 
 A custom Vue.js renderer for outputting content directly to the terminal (stdout), combining the flexibility of Vue with the power of console-based rendering.
 
diff --git a/packages/vue-stdout/package.json b/packages/vue-stdout/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@andrew_l/vue-stdout",
+  "description": "Renderer for terminal output with flexible layouts and CLI components.",
   "version": "0.2.17",
   "license": "MIT",
   "type": "module",

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@andrew_l/binlog",`
	`3`	`+ "description": "A high-performance binary logging system for Node.js applications.",`
`3`	`4`	`"version": "0.2.17",`
`4`	`5`	`"license": "MIT",`
`5`	`6`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@andrew_l/context",`
	`3`	`+ "description": "Like composition api but for Node.",`
`3`	`4`	`"version": "0.2.17",`
`4`	`5`	`"license": "MIT",`
`5`	`6`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@andrew_l/toolkit",`
	`3`	`+ "description": "General utility functions",`
`3`	`4`	`"version": "0.2.17",`
`4`	`5`	`"license": "MIT",`
`5`	`6`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@andrew_l/dom",`
	`3`	`+ "description": "Utility functions to simplify animations, clipboard operations, and smooth scrolling.",`
`3`	`4`	`"version": "0.2.17",`
`4`	`5`	`"license": "MIT",`
`5`	`6`	`"type": "module",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@andrew_l/graceful",`
	`3`	`+ "description": "Utility to manage application shutdown.",`
`3`	`4`	`"version": "0.2.17",`
`4`	`5`	`"license": "MIT",`
`5`	`6`	`"type": "module",`