Skip to content
This repository has been archived by the owner on Mar 28, 2024. It is now read-only.

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
alimd committed Nov 29, 2023
1 parent 9ed7389 commit 9053e79
Showing 1 changed file with 10 additions and 20 deletions.
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,19 @@

## Introduction

Necessary library for all ECMAScript (JavaScript/TypeScript) projects.
Essential library for all ECMAScript (JavaScript/TypeScript) projects.

Contains the following packages:
Comprises the following packages:

1. [Logger](./packages/logger): Fancy colorful console debugger with custom scope
2. [Crypto](./packages/crypto): Secure authentication HOTP token generator (the HMAC-based One-Time Password algorithm) and crypto utils written in tiny TypeScript module.
3. [Fetch](./packages/fetch): Enhanced fetch API with cache strategy, retry pattern, timeout, helper methods and enhanced types written in tiny TypeScript, ES module.
4. [Math](./packages/math): Simple useful Math library written in tiny TypeScript module.
5. [Nano Server](./packages/nano-server): Elegant powerful nodejs server for nanoservice use cases, written in tiny TypeScript module.
6. [Util](./packages/util): Util library written in tiny TypeScript module.
7. [Validator](./packages/validator): Simple useful validator library written in tiny TypeScript module.
1. [Logger](./packages/logger): Sophisticated, colorful console debugger with customizable scope
2. [Crypto](./packages/crypto): Secure authentication HOTP token generator (based on the HMAC-based One-Time Password algorithm) and cryptographic utilities written in a concise TypeScript module.
3. [Fetch](./packages/fetch): Enhanced fetch API with cache strategy, retry pattern, timeout, auxiliary methods, and improved types written in a concise TypeScript ES module.
4. [Math](./packages/math): Simple yet practical Math library written in a concise TypeScript module.
5. [Nano Server](./packages/nano-server): Exquisite, powerful nodejs server tailored for nanoservice use cases, written in a concise TypeScript module.
6. [Util](./packages/util): Utility library crafted in a concise TypeScript module.
7. [Validator](./packages/validator): Straightforward and valuable validator library written in a concise TypeScript module.

<!-- @TODO: update this list-->

## Installation

```bash
npm install @alwatr/module-name
```

## Usage

Follow each package's README for usage instructions.
Please refer to each package's README for more detailed information and usage instructions.

## License

Expand Down

0 comments on commit 9053e79

Please sign in to comment.