diff --git a/release-it.json b/.release-it.json similarity index 100% rename from release-it.json rename to .release-it.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..2e01e27 --- /dev/null +++ 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 = () => ; +```