Quickstart

Begin with a guide on the fastest path to a successful outcome

Describe how someone begins using your product. What is the first thing they need to do? Are there any prerequisites?

A quickstart should take someone from zero to using your product. They’ll get a quick win and a sense of what they can accomplish.

Prerequisites

Before you begin, you must have:

• Requirement one (for example, Node.js 18+, a free account, an API key)
• Requirement two (for example, a compatible device, a compatible browser, a compatible operating system)

Get started

1. Install

   Describe how to install your product or sign up.

   npm install your-package
   
2. Configure

   Describe any setup or configuration needed before first use.

   your-cli init
   
3. Run it

   Show the first thing a user does to see it working.

   your-cli start
   

Give people a way to get help. This could be a link to a support page, a chat with a customer support agent, or a forum for your product.

Example: Need help? Reach out to us at [e-mail].