docs: add readme

This commit is contained in:
afiqzudinhadi 2024-08-05 22:27:00 +08:00
parent c5221640c3
commit 29858e152d

36
README.md Normal file
View file

@ -0,0 +1,36 @@
# Sort Array By Letter
## Description
This utility takes a user input of array string number and sort it by the letter of each element. The utility will then display the sorted array.
## 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/sort-by-letters.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 of strings.