diff --git a/README.ko.md b/README.ko.md index 3195705..2d8b5e7 100644 --- a/README.ko.md +++ b/README.ko.md @@ -25,22 +25,26 @@ ## 빠른 시작 +**[create-starter](https://github.com/starter-series/create-starter) 사용** (권장): + ```bash -# 1. GitHub에서 "Use this template" 클릭 (또는 clone) -git clone https://github.com/starter-series/telegram-bot-starter.git my-bot -cd my-bot +npx @starter-series/create my-telegram-bot --template telegram-bot +cd my-telegram-bot && npm install +cp .env.example .env # @BotFather에서 받은 BOT_TOKEN 입력 +npm run dev +``` -# 2. 의존성 설치 -npm install +**또는 직접 clone:** -# 3. 환경 설정 (자세한 가이드: docs/TELEGRAM_SETUP.md) +```bash +git clone https://github.com/starter-series/telegram-bot-starter my-telegram-bot +cd my-telegram-bot && npm install cp .env.example .env -# .env 편집 → @BotFather에서 받은 BOT_TOKEN 입력 - -# 4. 봇 시작 npm run dev ``` +BotFather 상세 가이드는 [docs/TELEGRAM_SETUP.md](docs/TELEGRAM_SETUP.md) 참고. + ## 구성 ``` diff --git a/README.md b/README.md index 9113ef9..41041cb 100644 --- a/README.md +++ b/README.md @@ -25,22 +25,26 @@ Build your bot. Push to deploy. ## Quick Start +**Via [create-starter](https://github.com/starter-series/create-starter)** (recommended): + ```bash -# 1. Click "Use this template" on GitHub (or clone) -git clone https://github.com/starter-series/telegram-bot-starter.git my-bot -cd my-bot +npx @starter-series/create my-telegram-bot --template telegram-bot +cd my-telegram-bot && npm install +cp .env.example .env # fill in BOT_TOKEN from @BotFather +npm run dev +``` -# 2. Install dependencies -npm install +**Or clone directly:** -# 3. Set up environment (see docs/TELEGRAM_SETUP.md for detailed guide) +```bash +git clone https://github.com/starter-series/telegram-bot-starter my-telegram-bot +cd my-telegram-bot && npm install cp .env.example .env -# Edit .env → add BOT_TOKEN from @BotFather - -# 4. Start the bot npm run dev ``` +See [docs/TELEGRAM_SETUP.md](docs/TELEGRAM_SETUP.md) for the detailed BotFather guide. + ## What's Included ```