From f511e61e3413fe5fb687b889e0c85015564eb4d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Enis=20Muli=C4=87?= <enis.s.mulic@gmail.com>
Date: Sat, 4 Nov 2023 10:30:51 +0100
Subject: [PATCH] docs: add documentation for template options

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

diff --git a/README.md b/README.md
index 51c856e..29be9b2 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,20 @@ dotnet new install ./VerticalSliceMinimalApi
 dotnet new vsma --name ProjectName 
 ```
 
+## Synopsis
+```
+dotnet new vsma --name [ProjectName]
+    [-gh|--git-host [Github|AzureDevOps|None]]
+```
+
+### Options
+
+* `--name [ProjectName]`  
+  Specify the name of the project you are creating, this will replace all occurrences of `ProjectName` in the template with the name you pass in.
+
+* `-gh|--git-host [Github|AzureDevOps|None]`  
+  Choose the platform you will host your projects git repository, this will give you a base CI workflow, pull request template, and anything specific to the platform that might be of use. The default value is `None`.
+
 ## How to Run
 
 To start the app run: