Skip to content

Commit

Permalink
Add readme to every sample
Browse files Browse the repository at this point in the history
  • Loading branch information
vtnorton committed Dec 9, 2023
1 parent d52c5aa commit 85facee
Show file tree
Hide file tree
Showing 42 changed files with 1,151 additions and 15 deletions.
29 changes: 29 additions & 0 deletions js/cdn/autodesk/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Presence3D for Autodesk viewer (CDN/JS)

The Autodesk plugin from SuperViz SDK is designed to seamlessly integrate avatars, mouse-pointers, lasers, and host controls into your digital twin tool.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/contextual-comments-autodesk/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room with Contextual Comments for Autodesk (React/CDN)

Contextual Comments from the SuperViz SDK embeds a customizable commenting experience into your page or your 3D environment to enable people to collaborate.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/contextual-comments-html/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Contextual Comments for HTML (CDN/JS)

Contextual Comments from the SuperViz SDK embeds a customizable commenting experience into your page or your 3D environment to enable people to collaborate.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/contextual-comments-matterport/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Contextual Comments for Matterport (CDN/JS)

Contextual Comments from the SuperViz SDK embeds a customizable commenting experience into your page or your 3D environment to enable people to collaborate.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/contextual-comments-threejs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Contextual Comments for ThreeJS (CDN/JS)

Contextual Comments from the SuperViz SDK embeds a customizable commenting experience into your page or your 3D environment to enable people to collaborate.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/matterport/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Presence3D for Matterport (CDN/JS)

The Matterport plugin from SuperViz SDK is designed to seamlessly integrate avatars, mouse-pointers, lasers, and host controls into your digital twin tool. Additionally, the feature rich SuperViz SDK for Matterport provides ample flexibility for creating the ideal user experience for your Matterport tool.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/mouse-pointers/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Mouse Pointers (CDN/JS)

The Real-time Mouse Pointers feature enables real-time tracking of participants' cursor movements, allowing seamless collaboration within the same room. This is part of the SuperViz SDK.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/real-time-data-engine/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Real-time Data Engine (CDN/JS)

The Real-time Data Engine is a component of the SuperViz SDK that allows you to synchronize states between participants in a room. This enables various functionalities such as real-time data sharing, and event-driven communication for seamless collaborative experiences.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/threejs/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Presence3D for ThreeJS (CDN/JS)

The Three.js plugin from SuperViz SDK is designed to seamlessly integrate avatars, mouse, and host controls into your digital twin tool.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/video-conference/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Video Conference (CDN/JS)

The Video Conference, a key feature of the SuperViz SDK, empowers you with the ability to connect multiple participants in video meetings. This is part of the SuperViz SDK.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/cdn/who-is-online/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Who-is-Online (CDN/JS)

The Who-is-On-line component allows you to see participants who are connected in a room. This is part of the SuperViz SDK.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/react/autodesk/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room for Who Is Online (React/JS)

The Autodesk plugin from SuperViz SDK is designed to seamlessly integrate avatars, mouse-pointers, lasers, and host controls into your digital twin tool.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
29 changes: 29 additions & 0 deletions js/react/contextual-comments-autodesk/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Sample Room with Contextual Comments for Autodesk (React/JS)

Contextual Comments from the SuperViz SDK embeds a customizable commenting experience into your page or your 3D environment to enable people to collaborate.

### SuperViz SDK

This project hosts samples for SuperViz SDK. To find out more about the SDK itself, please visit [the documentation](https://docs.superviz.com/).

The SDK documentation has extensive sections about [getting started](https://docs.superviz.com/getting-started/quickstart), setting up the SDK, as well as the process of acquiring the required developer key.

## Build and run the samples

You can run this sample with npm:

```bash
npm install
npm start
```

or with Yarn:

```bash
yarn install
yarn start
```

Just make sure that you have the required developer keys in the `.env` file. For that copy the `.env.example` file to `.env` and fill in the values.

You will need Developer Key keys to run the samples on your machines, you therefore should [follow the instructions on these pages](https://docs.superviz.com/getting-started/setting-account) before continuing.
Loading

0 comments on commit 85facee

Please sign in to comment.