star-sdk-cli 0.1.12 → 0.1.13

package/README.md

@@ -0,0 +1,52 @@
+# star-sdk-cli
+
+CLI for [Star SDK](https://www.npmjs.com/package/star-sdk) — register games, deploy to hosting, and install AI coding docs.
+
+## Usage
+
+All commands run via `npx star-sdk` (no global install needed).
+
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `npx star-sdk init "Game Name"` | Register a game, get a gameId and deploy key |
+| `npx star-sdk deploy [path]` | Deploy your game to Star hosting |
+| `npx star-sdk install [agent]` | Install SDK docs for AI coding tools |
+| `npx star-sdk docs [topic]` | Print API docs (audio, canvas, leaderboard) |
+| `npx star-sdk whoami` | Show current game config |
+
+### Workflow
+
+```bash
+# 1. Register your game
+npx star-sdk init "My Game"
+# Creates .starrc with gameId and deploy key
+
+# 2. Build your game (use the gameId from .starrc)
+# ... write your game code ...
+
+# 3. Deploy
+npx star-sdk deploy
+# => Live at https://buildwithstar.com/games/<id>
+```
+
+### AI Agent Support
+
+Install SDK documentation directly into your AI coding tool:
+
+```bash
+npx star-sdk install          # Claude Code (default)
+npx star-sdk install cursor   # Cursor
+npx star-sdk install codex    # OpenAI Codex
+npx star-sdk install windsurf # Windsurf
+npx star-sdk install aider    # Aider
+```
+
+## Documentation
+
+Full docs at [buildwithstar.com/docs/sdk](https://buildwithstar.com/docs/sdk)
+
+## License
+
+MIT

package/dist/cli.mjs

@@ -231,6 +231,16 @@ Complete working games are in the \`examples/\` directory (also published with t
 - **reaction-time** \u2014 Test your reflexes over 5 rounds, DOM-based (no canvas)
 
 Each example is a single HTML file, no build step \u2014 imports from esm.sh.
+
+## Deploy
+
+When the game is ready, deploy it with one command:
+
+\`\`\`bash
+npx star-sdk deploy
+\`\`\`
+
+This uploads the game to Star hosting and returns a live URL. Requires \`npx star-sdk init\` to have been run first (which creates the deploy key in \`.starrc\`).
 `;
 var AUDIO_DOCS = `**Installation**
 
@@ -1098,7 +1108,7 @@ game(({ ctx, width, height, loop, ui, on, canvas }) => {
 - Score submission (works for guests and logged-in users)
 - Leaderboard UI (modal with rankings)
 - Weekly/all-time timeframes
-- AI-detected scoring (score/time/moves - higher or lower is better)
+- Configurable sort order (\`'asc'\` for lower-is-better, \`'desc'\` for higher-is-better)
 
 ---
 
@@ -1289,6 +1299,27 @@ const data = await leaderboard.getScores({
 
 ---
 
+**Sort Order:**
+
+By default, leaderboards rank higher scores first (\`'desc'\`). For games where lower is better (reaction time, speedruns, golf), set \`sort: 'asc'\`:
+
+\`\`\`javascript
+const leaderboard = createLeaderboard({ gameId: '<gameId from .starrc>', sort: 'asc' });
+\`\`\`
+
+**IMPORTANT: Do NOT invert scores to fake ascending order.** Use \`sort: 'asc'\` instead.
+
+\`\`\`javascript
+// BAD \u2014 do not do this
+leaderboard.submit(10000 - reactionTimeMs);
+
+// GOOD \u2014 submit the real value with sort: 'asc'
+const leaderboard = createLeaderboard({ gameId, sort: 'asc' });
+leaderboard.submit(reactionTimeMs);
+\`\`\`
+
+---
+
 **Tips:**
 
 1. **Call \`submit()\` before \`show()\`** - Ensures your score appears immediately in the leaderboard.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "star-sdk-cli",
-  "version": "0.1.12",
-  "description": "CLI tool for Star SDK - register games and manage leaderboards",
+  "version": "0.1.13",
+  "description": "CLI for Star SDK — register games, install AI docs, and deploy to Star hosting",
   "type": "module",
   "bin": {
     "star-sdk": "./dist/cli.mjs"
@@ -33,7 +33,9 @@
     "sdk",
     "cli",
     "games",
-    "leaderboard"
+    "leaderboard",
+    "deploy",
+    "hosting"
   ],
   "dependencies": {
     "archiver": "^7.0.0"