Перейти до основного вмісту
Опишіть, як хтось починає користуватися вашим продуктом. Що потрібно зробити в першу чергу? Чи є якісь попередні вимоги? Швидкий старт має провести користувача від нуля до використання вашого продукту. Він отримає швидку перемогу й розуміння того, чого можна досягти.

Попередні вимоги

Перш ніж розпочати, у вас має бути:
  • Вимога перша (наприклад, Node.js 18+, безкоштовний обліковий запис, API-ключ)
  • Вимога друга (наприклад, сумісний пристрій, сумісний браузер, сумісна операційна система)

Розпочнімо

1

Встановлення

Опишіть, як встановити ваш продукт або зареєструватися.
npm install your-package
2

Налаштування

Опишіть будь-яке налаштування або конфігурацію, потрібну перед першим використанням.
your-cli init
3

Запуск

Покажіть першу дію, яку виконує користувач, щоб побачити результат.
your-cli start
Дайте людям спосіб отримати допомогу. Це може бути посилання на сторінку підтримки, чат зі службою підтримки клієнтів або форум вашого продукту.Приклад: Потрібна допомога? Зв’яжіться з нами за адресою support@yourcompany.com.