utm-scroll-scene 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+# utm-scroll-scene
+
+Zipline-style scroll-driven drone delivery landing page component for React.
+
+## Install as dependency
+
+```bash
+npm install utm-scroll-scene
+```
+
+Install peer dependencies if not already present:
+
+```bash
+npm install react react-dom gsap motion three
+```
+
+## Usage
+
+```tsx
+import { ScrollScene } from "utm-scroll-scene";
+import "utm-scroll-scene/styles.css";
+
+export default function Page() {
+  return (
+    <>
+      <div className="zipline-spacer" style={{ height: "300vh" }} />
+      <ScrollScene />
+    </>
+  );
+}
+```
+
+**Assets:** Copy the `public/3d-models` folder from this package into your app's public directory so URLs like `/3d-models/assets/drone/scene.gltf` resolve.
+
+## Development (this repo)
+
+This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+
+Build the library: `npm run build:lib`
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.