From 901355a79424f6378c7c91476d98d57b214331db Mon Sep 17 00:00:00 2001 From: afiqzudinhadi Date: Sun, 28 Jul 2024 04:21:23 +0800 Subject: [PATCH] doc: add readme --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b941fa --- /dev/null +++ b/README.md @@ -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.