diff --git a/apps/docs/packages/telegram-apps-create-mini-app.md b/apps/docs/packages/telegram-apps-create-mini-app.md index b0bed733c..5f55688d4 100644 --- a/apps/docs/packages/telegram-apps-create-mini-app.md +++ b/apps/docs/packages/telegram-apps-create-mini-app.md @@ -9,7 +9,9 @@
-CLI tool to scaffold your new mini application on the Telegram Mini Apps platform. +`@telegram-apps/create-mini-app` is a CLI tool designed to scaffold your new +mini application on the Telegram Mini Apps platform. It generates a project with pre-configured libraries and template files, +allowing you to customize the content based on your specific requirements. ## Usage @@ -29,6 +31,32 @@ yarn create @telegram-apps/mini-app ``` ::: -The tool will launch the project initialization process, prompting you with questions related to the -required technologies for your project and ultimately creating your project using some well-known -templates. \ No newline at end of file +## Creating a New Application + +The above command executes a script that guides you through the creation of +your application by sequentially prompting for the following information: + +### 1. Project Directory Name + +- **Prompt**: Enter the name of the folder where the project files will be located. + +- **Default**: mini-app + The script will create a subfolder with the specified name in the current directory. + +### 2. Preferred Technologies + +| Option | Details | +|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Language** | Choose between **TypeScript** or **JavaScript**. | +| **SDK** | **• tma.js** [@telegram-apps/sdk](https://www.npmjs.com/package/@telegram-apps/sdk)