Add a simple README

9inpachi · Sep 8, 2024 · 76da4b9 · 76da4b9
1 parent 9093706
commit 76da4b9
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/release-it.json → .release-it.json b/release-it.json → .release-it.json
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+# Three Panorama Controls
+
+Panorama controls for three.js.
+
+## Setup
+
+Install the package.
+
+```sh
+npm install three-panorama-controls
+```
+
+## Usage
+
+The package can be used both in vanilla JavaScript and with React Three Fiber.
+
+### Vanilla
+
+```ts
+import { PanoramaControls } from "three-panorama-controls";
+
+// ...
+
+const controls = new PanoramaControls(camera, renderer.domElement);
+```
+
+### React Three Fiber
+
+```jsx
+import { PanoramaControls } from "three-panorama-controls/react";
+
+export const SampleComponent = () => <PanoramaControls makeDefault />;
+```