Skip to content

Commit

Permalink
docs: update README and package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
kiki-kanri committed Jul 22, 2024
1 parent 9068d40 commit b8025db
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 28 deletions.
49 changes: 28 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,23 @@
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]

Useful functions, constants, etc.
A utility library offering easy-to-use HTTP request wrappers, secure hash functions, flexible logging, datetime utilities, and more to simplify Node.js development.

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

## Features

- ✔️ Provides SHA-3 related hash functions, date formatting handling, and more
- ✔️ TypeScript support
- ✔️ Easy-to-use Axios wrappers for common HTTP methods
- 📜 Flexible and efficient console logging with Consola
- 🔒 Secure hash functions including MD5, SHA3-224, SHA3-256, SHA3-384, and SHA3-512
- 📅 Handy datetime utilities for formatting and manipulation
- 🔢 Enum helpers for extracting string and number values
- 🌱 Environment variable checker to ensure required values are set
- 🛡️ Middleware for logging in Hono framework
- 📈 Simple math utility for percentage calculations
- 💎 Utility for formatting numbers prettily
- 📜 Pino logging integration for enhanced log management
- 🔤 String utilities for generating random alphabetic strings

## Environment Requirements

Expand All @@ -33,6 +42,21 @@ That's it! You're ready to use this package in your project. Check out the instr

Some functions or the top of files will have related comments and examples.

- [axios](./src/axios.ts)
- axiosInstance
- axiosRequest
- axiosDelete
- $axiosDelete
- axiosGet
- $axiosGet
- axiosPatch
- $axiosPatch
- axiosPost
- $axiosPost
- axiosPut
- $axiosPut

- [consola](./src/consola.ts)
- [crypto-hash](./src/crypto-hash.ts)
- cryptoMd5
- cryptoMd5ToBuffer
Expand Down Expand Up @@ -65,30 +89,13 @@ Some functions or the top of files will have related comments and examples.
- [hono](./src/hono.ts)
- useHonoLogger

- [logger](./src/logger.ts)
- [math](./src/math.ts)
- calculateToPercentageString

- [number](./src/number.ts)
- prettyNumberToString

- [object](./src/object.ts)
- ksort

- [request](./src/request.ts)
- axiosInstance
- axiosRequest
- axiosDelete
- $axiosDelete
- axiosGet
- $axiosGet
- axiosPatch
- $axiosPatch
- axiosPost
- $axiosPost
- axiosPut
- $axiosPut

- [pino](./src/pino.ts)
- [string](./src/string.ts)
- randomAlphabeticString
- randomLowerCaseAlphabeticString
Expand Down
17 changes: 10 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@kikiutils/node",
"version": "3.1.0",
"description": "Useful functions, constants, etc.",
"description": "A utility library offering easy-to-use HTTP request wrappers, secure hash functions, flexible logging, datetime utilities, and more to simplify Node.js development.",
"license": "MIT",
"author": "kiki-kanri",
"repository": {
Expand Down Expand Up @@ -37,17 +37,20 @@
},
"keywords": [
"axios",
"consola",
"crypto",
"datetime",
"enum",
"environment",
"hash",
"hono",
"logger",
"http",
"logging",
"math",
"md5",
"object",
"node",
"pino",
"pretty-number",
"sha3",
"string"
"string",
"utilities"
],
"engines": {
"node": ">=18"
Expand Down

0 comments on commit b8025db

Please sign in to comment.