From 3525a8aa71d328eab4480a6b8d1f2f86811a2680 Mon Sep 17 00:00:00 2001 From: Ali Mihandoost Date: Fri, 22 Dec 2023 19:58:52 +0330 Subject: [PATCH] docs(readme): Update utility package descriptions --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1327acc2..6145ebb1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ # Alwatr NanoLib -This repository contains numerous small utility packages. These packages serve various useful purposes and are written in TypeScript. +This repository contains numerous small utility packages. These packages serve various useful purposes and are written in nano ESModule without any dependencies. Here is a brief overview of the included libraries: -1. [`@alwatr/tsconfig-base`](./packages/tsconfig-base/README.md): A base TypeScript configuration for Alwatr projects. -2. [`@alwatr/flat-string`](./packages/flat-string/README.md): A utility for simplifies the complex C structures that are part of a combined JavaScript string. +1. [`tsconfig-base`](./packages/tsconfig-base/README.md): This is a foundational TypeScript configuration used for Alwatr projects. +2. [`flat-string`](./packages/flat-string/README.md): The `flat-string` function flattens the underlying C structures of a concatenated JavaScript string. +3. [`global-scope`](./packages/global-scope/README.md): This TypeScript module provides a cross-platform alternative to `globalThis` named `globalScope`. This object works across different environments, including browsers (`window`), Node.js (`global`), and Web Workers (`self`). +4. [`platform-info`](./packages/platform-info/README.md): This module offers a method to identify the current platform where the script is being executed. It defines a `platformInfo` constant that contains details about the current platform. +5. [`prettier-config`](./packages/prettier-config/README.md): These are Alwatr's shared configurations for Prettier. +6. [`eslint-config`](./packages/eslint-config/README.md): This is Alwatr's ECMAScript Style Guide presented as shareable ESLint configurations. +7. [`deep-clone`](./packages/deep-clone/README.md): This function allows you to clone deeply nested objects and arrays in JavaScript. +8. [`nano-build`](./packages/nano-build/README.md): This is a tool for building/bundling ECMAScript, TypeScript, and JavaScript libraries. It's user-friendly, requires no setup, follows best practices, has no dependencies, and uses esbuild for improved performance. +9. [`async-queue`](./packages/async-queue/README.md): This is a utility for managing asynchronous operations in a queue. For more detailed information and guidelines on how to use each package, please refer to to each package's README.