From a0fcd7fda0427d03795e882553aa18d943b237f4 Mon Sep 17 00:00:00 2001
From: INeedJobToStartWork <ineedjobtostartwork@gmail.com>
Date: Mon, 8 Jan 2024 17:02:03 +0100
Subject: [PATCH 1/3] Create README.md

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..83412b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+![CommitSmileBanner](https://github.com/INeedJobToStartWork/Commit-Smile/assets/97305201/7b18af3e-7472-47f5-99e8-6f97574d2ea7)
+
+# 📜 List of Contest
+- [Install](#list-of-contest)
+- [How to start](#how-to-start)
+- [Config](#config)
+  - [Custom file path](#custom-file-path)
+  - [Init config](#init-config)
+
+## Install
+NPM
+```bash copy
+npm install -D commitSmile
+```
+PNPM
+```bash copy
+pnpm add -D commitSmile
+```
+Yarn
+```bash copy
+yarn add -D commitSmile
+```
+
+### How to start
+👋Hello! Glad to see you! There is order task to setup:
+
+### Config
+In Default execute app is looking for files names match `/commitsmile.*\.(json|mjs|cjs|js|mts|cts|ts)/iu`
+
+- Name: commitsmile (letters can be uppercase or lowercase or mixed)
+- pre ext (optional) 
+- Ext: `json|mjs|cjs|js|mts|cts|ts`
+
+examples:
+- `commitsmile.discord.ts`
+- `coMMitSmile.json`
+
+### Custom file path
+To set custom path to config we can use optional parameter `-C,--config` where `<PATH>` can be relative or absolute path:
+```bash copy
+npm run commitSmile -C <PATH>
+```
+If Path:
+- do not include filename it will use standard process to find.
+- include - will just check this file (faster way)
+
+### Init config
+to init config we use optional paremeter `--init`:
+```bash copy
+npm run commitSmile --init
+```
+

From 1b7aa99d688ea3ce9c3903bcd726d9fac0f90109 Mon Sep 17 00:00:00 2001
From: INeedJobToStartWork <ineedjobtostartwork@gmail.com>
Date: Mon, 8 Jan 2024 17:03:04 +0100
Subject: [PATCH 2/3] Update README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 83412b0..78ceb60 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 ![CommitSmileBanner](https://github.com/INeedJobToStartWork/Commit-Smile/assets/97305201/7b18af3e-7472-47f5-99e8-6f97574d2ea7)
 
-# 📜 List of Contest
+#📜 List of Contest
 - [Install](#list-of-contest)
 - [How to start](#how-to-start)
 - [Config](#config)

From 66c2e09579a147d32dc33955cccb811cb05f818c Mon Sep 17 00:00:00 2001
From: INeedJobToStartWork <ineedjobtostartwork@gmail.com>
Date: Mon, 8 Jan 2024 17:03:18 +0100
Subject: [PATCH 3/3] Update README.md

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 78ceb60..6ad3096 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 ![CommitSmileBanner](https://github.com/INeedJobToStartWork/Commit-Smile/assets/97305201/7b18af3e-7472-47f5-99e8-6f97574d2ea7)
 
-#📜 List of Contest
-- [Install](#list-of-contest)
+# 📜 List of Contest
+- [Install](#-list-of-contest)
 - [How to start](#how-to-start)
 - [Config](#config)
   - [Custom file path](#custom-file-path)