Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,28 @@ Try Shotstack Studio in your preferred framework:
[![Angular](https://img.shields.io/badge/Angular-StackBlitz-blue?style=for-the-badge&logo=angular)](https://stackblitz.com/fork/github/shotstack/shotstack-studio-sdk-demos/tree/master/angular)
[![Next.js](https://img.shields.io/badge/Next.js-StackBlitz-blue?style=for-the-badge&logo=next.js)](https://stackblitz.com/fork/github/shotstack/shotstack-studio-sdk-demos/tree/master/nextjs)

## Create a new project

The fastest way to get started is to scaffold a project. This creates a small app with the Studio SDK already set up, including the canvas, timeline, and controls.

```bash
npm create video-editor@latest
# or
npx create-video-editor
```

You'll be asked for a project name and a framework. The CLI then scaffolds the app, installs dependencies, starts the dev server, and opens a live editor in your browser.

```bash
npx create-video-editor my-video-editor
```

To skip the prompts, pass the project directory and framework directly:

```bash
npx create-video-editor my-editor --template react --yes
```

## Features

- Template-driven editing with undo/redo command model
Expand All @@ -26,6 +48,8 @@ Try Shotstack Studio in your preferred framework:

## Installation

To add the SDK to an existing app, install it directly:

```bash
npm install @shotstack/shotstack-studio
```
Expand Down
Loading