react-rubiks-cube 0.1.0 → 0.1.2

package/README.md

@@ -7,9 +7,13 @@
 It scrambles and solves itself in an endless loop, tumbles gently in 3D, and — when you click it — opens a fullscreen playground where you can drag faces to turn them or drive it with Rubik's-notation buttons. Fully themeable, ~8 kB gzipped, zero configuration to drop in.
 
 [![npm](https://img.shields.io/npm/v/react-rubiks-cube?color=E05C28)](https://www.npmjs.com/package/react-rubiks-cube)
-[![license](https://img.shields.io/github/license/chahe-dridi/cubex?color=00C9A7)](./LICENSE)
+[![license](https://img.shields.io/github/license/chahe-dridi/cubex?color=00C9A7)](https://github.com/chahe-dridi/cubex/blob/master/LICENSE)
 [![stars](https://img.shields.io/github/stars/chahe-dridi/cubex?style=social)](https://github.com/chahe-dridi/cubex/stargazers)
 
+### [▶ Live demo](https://cubex-fawn-xi.vercel.app)
+
+<a href="https://cubex-fawn-xi.vercel.app"><img src="https://raw.githubusercontent.com/chahe-dridi/cubex/master/.github/media/hero.gif" alt="Three cubex cubes, in the brand, classic and a custom purple palette, scrambling and solving themselves while they tumble in 3D" width="760"></a>
+
 [Features](#features) · [Install](#install) · [Quick start](#quick-start) · [Props](#props) · [Theming](#theming) · [Advanced](#advanced)
 
 **Like it? [⭐ Star the repo](https://github.com/chahe-dridi/cubex) — it genuinely helps others find it.**
@@ -27,6 +31,12 @@ It scrambles and solves itself in an endless loop, tumbles gently in 3D, and —
 - 🧩 **Composable** — use the one-line `<RubiksCube />`, or drop the underlying scenes into your own `<Canvas>`.
 - 🔒 **TypeScript** — full typings included.
 
+### Click a cube to play with it
+
+<img src="https://raw.githubusercontent.com/chahe-dridi/cubex/master/.github/media/playground.gif" alt="The fullscreen playground: the cube turns as the R, U, F, L and D notation buttons are pressed in the control panel" width="560">
+
+Drag a face to turn a slice, orbit to look around, or use the Rubik's-notation buttons. Left alone, it undoes your moves and solves itself.
+
 ## Install
 
 ```bash
@@ -173,8 +183,41 @@ cd cubex
 npm install
 npm run dev      # runs the interactive demo in example/
 npm run build    # builds the library into dist/
+npm run media    # re-records the README GIFs (needs Chrome; run build:demo first)
+```
+
+## Roadmap & contributing
+
+Contributions are very welcome — the repo has a set of scoped issues to pick from:
+
+- 🟢 **Good first issues** — [more built-in palettes](https://github.com/chahe-dridi/cubex/issues/7), [`prefers-reduced-motion` support](https://github.com/chahe-dridi/cubex/issues/1), [a preview GIF](https://github.com/chahe-dridi/cubex/issues/3)
+- ✨ **Features** — [imperative `scramble()`/`solve()` API](https://github.com/chahe-dridi/cubex/issues/4), [keyboard controls](https://github.com/chahe-dridi/cubex/issues/5), [NxN cubes](https://github.com/chahe-dridi/cubex/issues/6)
+
+See all [open issues](https://github.com/chahe-dridi/cubex/issues). Grab one, comment to claim it, then follow the flow below.
+
+### Branching model
+
+| Branch    | Role                                                                 |
+| --------- | ------------------------------------------------------------------- |
+| `master`  | Stable / release branch. This is what npm publishes and what `npm install github:chahe-dridi/cubex` pulls. Never push straight to it. |
+| `dev`     | Integration branch. All work lands here first and is tested together. |
+| `feat/*`  | Your working branch, one per issue.                                 |
+
+**All pull requests target `dev`, not `master`.** Once changes on `dev` are tested and stable, a maintainer merges `dev → master` and cuts a release.
+
+```bash
+# 1. Branch off dev
+git checkout dev && git pull
+git checkout -b feat/reduced-motion    # e.g. issue #1
+
+# 2. Do the work, then push
+git push -u origin feat/reduced-motion
+
+# 3. Open a PR into dev
 ```
 
+See [CONTRIBUTING.md](https://github.com/chahe-dridi/cubex/blob/master/CONTRIBUTING.md) for the full guide.
+
 ## Support
 
 If cubex saved you some time or just made you smile:
@@ -187,4 +230,4 @@ Every star and share is genuinely appreciated. 🙏
 
 ## License
 
-[MIT](./LICENSE) © chahe-dridi
+[MIT](https://github.com/chahe-dridi/cubex/blob/master/LICENSE) © chahe-dridi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-rubiks-cube",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "A beautiful, self-solving 3D Rubik's Cube React component — auto scramble/solve loop, drag-to-turn interaction, and a fully themeable palette. Built on react-three-fiber.",
   "type": "module",
   "license": "MIT",
@@ -46,8 +46,10 @@
   "scripts": {
     "dev": "vite",
     "build": "vite build",
-    "preview": "vite preview --outDir example-dist",
-    "prepare": "vite build"
+    "build:demo": "vite build --config vite.demo.config.js",
+    "preview": "vite preview --config vite.demo.config.js",
+    "prepare": "vite build",
+    "media": "node scripts/readme-media.mjs"
   },
   "peerDependencies": {
     "@react-three/drei": ">=9.0.0",
@@ -62,6 +64,9 @@
     "@react-three/fiber": "^8.18.0",
     "@vitejs/plugin-react": "^4.3.1",
     "framer-motion": "^11.3.0",
+    "gifenc": "^1.0.3",
+    "pngjs": "^7.0.0",
+    "puppeteer-core": "^25.16.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "three": "^0.186.1",