Skip to content

Commit

Permalink
docs(readme): Update utility package descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
AliMD committed Dec 22, 2023
1 parent 7083302 commit 3525a8a
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3525a8a

Please sign in to comment.