From f89f9045e2ffc3605c255c2d7e24a89249992816 Mon Sep 17 00:00:00 2001 From: afiqzudinhadi Date: Fri, 12 Jul 2024 15:39:41 +0800 Subject: [PATCH] chore: add readme --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f440851 --- /dev/null +++ b/README.md @@ -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!).