From 272a5f677b2f14bb34c1d4c58abe370a644db094 Mon Sep 17 00:00:00 2001
From: Pawel Bartusiak <21136755+uFloppyDisk@users.noreply.github.com>
Date: Fri, 28 Mar 2025 21:23:36 -0700
Subject: [PATCH 1/3] docs(README): add command-line argument examples;
---
README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 46 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index df57ed3..56e25e3 100644
--- a/README.md
+++ b/README.md
@@ -77,8 +77,53 @@ Run on-demand via pnpm:
## Usage
-Follow the prompts to generate your CounterStrike Sharp plugin!
+#### Interactive prompts
+Create your CounterStrikeSharp plugin project using interactive step-by-step prompts in
+your terminal.
+Run `create-cssharp-plugin` with no arguments to enter interactive mode and follow
+the prompts.\
+ex. `npx create-cssharp-plugin`
+
+#### Command-line arguments
+Generate your CounterStrikeSharp plugin project directly from the command line.
+
+
+ Generate a project named "example"
+
+`create-cssharp-plugin example`
+
+
+
+ Generate a project with a different plugin name(space).
+
+`create-cssharp-plugin -p differentName example`
+
+
+
+ Generate a project with an author and description
+
+`create-cssharp-plugin -a JohnCSSharp -d "It's CSSharping time" example`
+
+
+> [!NOTE]
+> If you specify a project directory as the first positional argument when running
+`create-cssharp-plugin`, all interactive prompts will be skipped and defaults will apply.
+
+
+ Enter interactive mode after passing arguments
+
+Show prompts and skip those set via arguments:\
+`create-cssharp-plugin -i example`
+
+Forcibly show all prompts with initial values populated from arguments:\
+`create-cssharp-plugin -I example`
+
+
+> [!NOTE]
+> View CLI usage help by passing `-h` or `--help`
+
+## Project Structure
Projects generated using `create-cssharp-plugin` have the following structure:
```
./projectName
From 15081fee4d2e06dc55c1b1b7628c6a264bb00e25 Mon Sep 17 00:00:00 2001
From: Pawel Bartusiak <21136755+uFloppyDisk@users.noreply.github.com>
Date: Mon, 31 Mar 2025 18:13:52 -0700
Subject: [PATCH 2/3] chore(README): move help option tip to top of section;
---
README.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 56e25e3..fbb0a69 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,9 @@ ex. `npx create-cssharp-plugin`
#### Command-line arguments
Generate your CounterStrikeSharp plugin project directly from the command line.
+> [!TIP]
+> View CLI options and usage help by passing `-h` or `--help`
+
Generate a project named "example"
@@ -120,9 +123,6 @@ Forcibly show all prompts with initial values populated from arguments:\
`create-cssharp-plugin -I example`
-> [!NOTE]
-> View CLI usage help by passing `-h` or `--help`
-
## Project Structure
Projects generated using `create-cssharp-plugin` have the following structure:
```
From 87e6123b4fa718bc39aed3c2cfb77d542750bac0 Mon Sep 17 00:00:00 2001
From: Pawel Bartusiak <21136755+uFloppyDisk@users.noreply.github.com>
Date: Mon, 31 Mar 2025 18:38:20 -0700
Subject: [PATCH 3/3] chore(README): add section for add'l CLI option recipes;
---
README.md | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/README.md b/README.md
index fbb0a69..d6f1fa0 100644
--- a/README.md
+++ b/README.md
@@ -123,6 +123,15 @@ Forcibly show all prompts with initial values populated from arguments:\
`create-cssharp-plugin -I example`
+
+ More CLI option recipes
+
+Say yes to all default build tasks (ex. git init) and ask remaining prompts interactively:\
+`create-cssharp-plugin -yi example`\
+`create-cssharp-plugin -yip differentName example`
+
+
+
## Project Structure
Projects generated using `create-cssharp-plugin` have the following structure:
```