chore: add readme

This commit is contained in:
afiqzudinhadi 2024-07-12 15:39:41 +08:00
parent 61a5b13dc4
commit f89f9045e2

36
README.md Normal file
View file

@ -0,0 +1,36 @@
# Group and Sort Array Items
## Description
This utility takes a user input of numbers or strings, groups them based on their value, and then sorts these group in order.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
## Installation
To use the code in this repository, you need to have [Node.js](https://nodejs.org/en) installed on your machine. Clone the repository to your local system using the following command:
```
git clone https://github.com/afiqzudinhadi/advanced-list-sort.git
```
Install the required dependencies by running the following command:
```
npm install
```
## Usage
1. Navigate to the repository's root directory.
2. Open terminal or command prompt.
3. Run the following command to execute the code:
```
npm run index
```
4. Follow the on-screen instructions to input the array items (strings or numbers or both!).