Skip to content

Commit

Permalink
docs: update README and description in package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
kiki-kanri committed Jul 20, 2024
1 parent d147783 commit 8a24ff0
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,34 @@
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]

Utility functions, constants, tools, etc.
Useful functions, constants, etc.

- [✨ Release Notes](./CHANGELOG.md)

## Installation
## Features

```bash
# Using pnpm
pnpm add @kikiutils/node
- ✔️ Provides SHA-3 related hash functions, date formatting handling, and more
- ✔️ TypeScript support

## Environment Requirements

# Using yarn
yarn add @kikiutils/node
- Node.js version 18 or higher

# Using npm
npm i @kikiutils/node
## Installation

Add dependency (example using pnpm).

# Using bun
bun add @kikiutils/node
```bash
pnpm add @kikiutils/node
```

## Environmental Requirements
You can also use yarn, npm, or bun to add the dependency.

- ESM only
- Node.js 18 or higher
That's it! You're ready to use this package in your project. Check out the instructions for [functions](#functions) below. ✨

## Functions

The relevant comments are at the top of the file or on functions and constants.
Some functions or the top of files will have related comments and examples.

- [crypto-hash](./src/crypto-hash.ts)
- cryptoSha3224
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@kikiutils/node",
"version": "2.0.0",
"description": "Utility functions, constants, tools, etc.",
"description": "Useful functions, constants, etc.",
"license": "MIT",
"author": "kiki-kanri",
"repository": {
Expand Down

0 comments on commit 8a24ff0

Please sign in to comment.