doc: add readme
This commit is contained in:
parent
888243d07b
commit
901355a794
1 changed files with 32 additions and 0 deletions
32
README.md
Normal file
32
README.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Check If It's a Title String
|
||||
|
||||
## Description
|
||||
This utility checks if a given string is a title string. A title string is a string that has the first letter of each word capitalized and the rest of the letters in lowercase.
|
||||
|
||||
## 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/check-string-title-capitalize.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 string and check if it is a title string.
|
||||
Loading…
Add table
Add a link
Reference in a new issue