From a6a755042d5eb0e2cdb33fd8a1f2e55e9d1183b7 Mon Sep 17 00:00:00 2001
From: "pavel.muhortov" <pavel.muhortov@noreply.localhost>
Date: Thu, 5 Jan 2023 19:25:24 +0300
Subject: [PATCH] add basic design

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 248b984..664aec2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
 # template-bash
+Template repository for projects on bash
 
+* [`script.sh`](https://git.hmp.today/pavel.muhortov/template-bash#script)
+
+____
+## `script`
+**Description:**  
+> returning current username if privileged rights are exist  
+> or  
+> returning error, if privileged rights are not exist
+
+
+**Dependencies:**  
+> - bash (tested version 5.1.4 on Debian GNU/Linux 11)
+
+
+|  POSITION | PARAMETERS   |       DESCRIPTION      |    DEFAULT    |
+|-----------|--------------|------------------------|---------------|
+|     1     |    **[qn]**    |execution without pauses|     `None`    |
+|     2     |    **[/path/to/conf]**    |path to config|     ./script.conf    |
+
+
+Example usage in terminal with bash:
+```shell
+bash ./script.sh qn ./script.conf
+```
+Example usage in terminal with make the script executable:
+```shell
+chmod u+x ./script.sh
+script.sh
+```