diff --git a/README.md b/README.md index df57ed3..d6f1fa0 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,62 @@ 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. + +> [!TIP] +> View CLI options and usage help by passing `-h` or `--help` + +
+ 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` +
+ +
+ 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: ``` ./projectName