Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cephalization committed Dec 6, 2024
1 parent edf9af9 commit eeeceee
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,46 @@
</p>

A point cloud library for visualizing point clouds using 2D and 3D canvases.

## Installation

```bash
# or pnpm, yarn, etc
npm install @arizeai/point-cloud @react-three/drei
```

## Usage

Basic usage:

```tsx
import { ThreeDimensionalCanvas, ThreeDimensionalControls, Points, type PointBaseProps } from '@arizeai/point-cloud';

const data: PointBaseProps[] = [
{ position: [0, 0, 0], metaData: {} },
{ position: [1, 1, 1], metaData: {} },
];

export const PointCloud = () => {
return (
<ThreeDimensionalCanvas>
<ThreeDimensionalControls />
<Points data={data} pointProps={{ color: '#7BFFFF' }} />
</ThreeDimensionalCanvas>
);
};
```

See additional usage examples in Storybook.

```bash
npm run storybook
```

## Usage with React 19

React 19 is not yet supported by stable versions of `@react-three/drei`. To use this library with React 19, you can try the following:

```bash
npm install @arizeai/point-cloud @react-three/drei@alpha
```

0 comments on commit eeeceee

Please sign in to comment.