From 391e6cedef6b73a8e1ef0f132dc64b748eb9d808 Mon Sep 17 00:00:00 2001
From: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
Date: Sat, 10 Jun 2023 20:41:17 -0500
Subject: [PATCH] Create README.md

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..41dc048
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+# @sern/create-bot
+
+## Scaffolding sern projects
+
+With NPM:
+
+```bash
+$ npm create @sern/bot
+```
+
+With Yarn:
+
+```bash
+$ yarn create @sern/bot
+```
+
+With PNPM:
+
+```bash
+$ pnpm create @sern/bot
+```
+
+Then follow the prompts!
+
+You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Typescript project, run:
+
+```bash
+# npm 6.x
+npm create @sern/bot --template=ts-esm --name="mybot"
+
+# npm 7+, extra double-dash is needed:
+npm create @sern/bot -- --template=ts-esm --name="mybot"
+
+# !!!!POWERSHELL SYNTAX
+npm create @sern/bot '--' --template=ts-esm --name="mybot"
+
+# yarn
+yarn create @sern/bot --template=vue --name="mybot"
+
+# pnpm
+pnpm create @sern/bot --template=vue --name="mybot"
+```
+
+Currently supported template presets include:
+
+- `ts`
+- `ts-esm`
+- `js`
+- `js-esm`