From 84be4882e2f1169b392895c12b035e1157a4be9f Mon Sep 17 00:00:00 2001
From: "pavel.muhortov" <pavel.muhortov@noreply.localhost>
Date: Sat, 7 Jan 2023 10:17:48 +0300
Subject: [PATCH] add basic design

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

diff --git a/README.md b/README.md
index 77f1384..825f6cc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,31 @@
 # template-posh
 
-Template repository for projects on posh
\ No newline at end of file
+Template repository for projects on posh
+
+* [`script.ps1`](https://git.hmp.today/pavel.muhortov/template-posh#script-ps1)
+
+____
+## `script.ps1`
+**Description:**  
+> returning current username if privileged rights are exist  
+> or  
+> returning error, if privileged rights are not exist
+
+
+**Dependencies:**  
+> - powershell (tested version 5.1)
+
+
+|  PARAMETERS | DESCRIPTION | DEFAULT|
+|-------------|-------------|--------|
+|**[-show]**|""   - execution with pauses.<br/>"qn" - execution without pauses.||
+|**[-conf]**|path to configuration file|.\script.conf|
+
+
+Example usage in terminal with powershell:
+```shell
+powershell .\script.ps1
+```
+```shell
+.\script.ps1 qn .\script.conf
+```