Update README and package.json for improved descriptions and formatting
parent
9ca662d96c
commit
381fb28675
76
README.md
76
README.md
|
@ -2,36 +2,76 @@
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
utiliyo is a collection of utilities that facilitate software development in a javascript environment.
|
**utiliyo** is a lightweight utility library designed to simplify common tasks in JavaScript development. It provides a set of well-structured and reusable functions that enhance productivity and code maintainability.
|
||||||
|
|
||||||
## Package installation
|
## Installation
|
||||||
|
|
||||||
|
You can install **utiliyo** using either `npm` or `yarn` from my private registry:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
// with npm
|
# Using npm
|
||||||
npm i --save @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
|
npm install --save @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
|
||||||
|
|
||||||
// with yarn
|
# Using yarn
|
||||||
yarn add @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
|
yarn add @flare/utiliyo --registry https://lab.code-rove.com/public-node-registry
|
||||||
```
|
```
|
||||||
|
|
||||||
## How to use the package
|
## Usage
|
||||||
|
|
||||||
```jsx
|
Import and use the utility functions in your project:
|
||||||
|
|
||||||
|
```javascript
|
||||||
import { typeValidator, localStorage, camelizeKeys } from "@flare/utiliyo";
|
import { typeValidator, localStorage, camelizeKeys } from "@flare/utiliyo";
|
||||||
```
|
```
|
||||||
|
|
||||||
## Unit testing
|
## Features
|
||||||
|
|
||||||
Unit testing is done using [Jest](https://jestjs.io/). This is an awesome testing framework created by Facebook.
|
- **Type Validation** – Validate data types efficiently.
|
||||||
The files containing tests are identified by the extension `*.test.ts`.
|
- **Local Storage Utilities** – Simplify interactions with `localStorage`.
|
||||||
All tests in the package can be executed by running: `npm test`.
|
- **Data Formatting** – Includes functions like `camelizeKeys` to transform object keys.
|
||||||
|
|
||||||
|
## Unit Testing
|
||||||
|
|
||||||
|
All utilities are rigorously tested using [Jest](https://jestjs.io/), a powerful testing framework developed by Facebook.
|
||||||
|
|
||||||
|
- Test files follow the naming convention `*.test.ts`.
|
||||||
|
- Run all tests with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm test
|
||||||
|
```
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
1.0.0 - This version includes data type validators and local storage utils
|
#### v1.2.0
|
||||||
1.0.1 - Set new domain in configs
|
|
||||||
1.0.2 - Utility functions export fix
|
- Rebranded package from `js-utils` to `utiliyo`.
|
||||||
1.0.3 - Typescript warnings fix
|
|
||||||
1.0.4 - Added "camelizeKeys" function
|
#### v1.1.0
|
||||||
1.1.0 - The package has been migrated to TypeScript. Unit tests using Jest have also been added.
|
|
||||||
1.2.0 - Rebrand package from js-utils to utiliyo.
|
- Migrated the package to TypeScript.
|
||||||
|
- Added unit tests using Jest.
|
||||||
|
|
||||||
|
#### v1.0.4
|
||||||
|
|
||||||
|
- Introduced the `camelizeKeys` function.
|
||||||
|
|
||||||
|
#### v1.0.3
|
||||||
|
|
||||||
|
- Fixed TypeScript warnings.
|
||||||
|
|
||||||
|
#### v1.0.2
|
||||||
|
|
||||||
|
- Fixed issues with utility function exports.
|
||||||
|
|
||||||
|
#### v1.0.1
|
||||||
|
|
||||||
|
- Updated domain configurations.
|
||||||
|
|
||||||
|
#### v1.0.0
|
||||||
|
|
||||||
|
- Initial release with data type validators and local storage utilities.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
For further details, contributions, or issue reporting, visit the [repository](https://lab.code-rove.com/gitea/bricks/utiliyo).
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "@flare/utiliyo",
|
"name": "@flare/utiliyo",
|
||||||
"version": "1.2.0",
|
"version": "1.2.0",
|
||||||
"description": "utiliyo is a collection of utilities that facilitate software development in a javascript environment.",
|
"description": "utiliyo is a lightweight utility library designed to simplify common tasks in JavaScript development. It provides a set of well-structured and reusable functions that enhance productivity and code maintainability.",
|
||||||
"main": "./lib/index.js",
|
"main": "./lib/index.js",
|
||||||
"types": "./lib/index.d.ts",
|
"types": "./lib/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|
Loading…
Reference in New Issue