<!-- PROJECT LOGO -->
<p align="center">
  <a href="https://realtime.cloudflare.com">
    <img src="https://docs.realtime.cloudflare.com/logo/cf.svg" alt="Logo" width="120" />
  </a>

  <h3 align="center">RealtimeKit Recording SDK by Cloudflare</h3>

  <p align="center">
    Cloudflare RealtimeKit recording SDK to make custom UIs for recordings.
    <br />
    <a href="https://docs.realtime.cloudflare.com/guides/capabilities/recording/create-record-app-using-sdks"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    ·
    <a href="https://dyte.io/contact">Report Bug</a>
    ·
    <a href="https://dyte.io/contact">Request Feature</a>
  </p>
</p>

<!-- TABLE OF CONTENTS -->

## Table of Contents

- [About the Project](#about-the-project)
  - [Built With](#built-with)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)

<!-- ABOUT THE PROJECT -->

## About The Project

The `@cloudflare/realtimekit-recording-sdk` powers the business logic for custom recording UIs.

### Built With

This SDK is built using TypeScript.

<!-- GETTING STARTED -->

## Getting Started

Follow the steps below to install `@cloudflare/realtimekit-recording-sdk` in your project.

### Prerequisites

- [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or [yarn](https://yarnpkg.com/getting-started/install)

### Installation

Install using NPM

```sh
npm install @cloudflare/realtimekit-recording-sdk
```

OR

Install using yarn

```sh
yarn add @cloudflare/realtimekit-recording-sdk
```

<!-- USAGE -->

## Usage

To get a detailed description of how to use this library, check out the _[official documentation](https://docs.realtime.cloudflare.com/guides/capabilities/recording/create-record-app-using-sdks)_.

## Examples

You can find a sample implementation of the recording SDK in the [react-samples](https://github.com/dyte-io/recording-sdk-app-samples) directory.

<!--- LICENSE -->

## License

All rights reserved. © Cloudflare Inc.
