docs: Initial configuration + install guide

[greynewell]

Summary by CodeRabbit

• Chores

  • Added automated CI to test and build on pushes and pull requests to main
  • Updated project metadata (description, author, homepage, issue link) and keywords
  • Added type-checking to npm scripts and configured distribution packaging

• Documentation

  • Revamped README with installation instructions, quick-start example, method reference, and links to API docs and OpenAPI spec

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adds a GitHub Actions CI workflow, updates package metadata and scripts, and replaces the README with a rebranded "Supermodel TypeScript SDK" guide including install and quick-start examples. No exported/public API signatures were changed. (48 words)

Changes

Cohort / File(s)	Summary
CI/CD Setup .github/workflows/ci.yml	New GitHub Actions workflow named "CI": runs on pushes/PRs to main, uses ubuntu-latest, checks out code, sets up Node.js 20 with npm cache, runs npm ci, npm run typecheck, and npm run build.
Project Configuration package.json	Updated project metadata (description, author, license, homepage, bugs, repository.url), added keywords and files: ["dist"], added typecheck script (tsc --noEmit), and minor script formatting change. No main/typings path changes.
Documentation README.md	Full rewrite and rebrand to "Supermodel TypeScript SDK": new badges, Install section, Quick Start TS example, Methods table (notes idempotencyKey/file required), and Links to API docs/OpenAPI spec.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

CI hums at dawn, new badges gleam,
package.json learns a polished dream,
README tells devs how to start,
build and typecheck play their part,
ship the SDK — small, steady stream. 🚀

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: Initial configuration + install guide' partially captures the changes, which include CI workflow setup, README restructuring, and package.json metadata updates—but emphasizes documentation aspects while downplaying the infrastructure and configuration work.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 893074a and 5afe547.

📒 Files selected for processing (1)

• README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (3)

.github/workflows/ci.yml (1)

12-29: Consider adding test and lint steps.

Right now you're running typecheck and build, which is great! But you might want to add test and lint steps too if you have them set up (or plan to). Something like:

      - name: Lint
        run: npm run lint

      - name: Test
        run: npm test

This is totally optional for now since you're just getting started, but it's worth thinking about as the project grows.

README.md (2)

1-6: Nice clean header!

The badges and description look great. One tiny thing: the TypeScript badge shows "5.0" but your package.json accepts "^4.0 || ^5.0", so someone using TypeScript 4.x might be a bit confused. Maybe change the badge to say "4.0+" or "5.0+" to be more accurate?

This is super minor though, totally up to you.

---

30-33: Consider showing error handling in the example.

The example is clean, but real-world API calls can fail. It might be helpful to show users how to handle errors, especially since this is the Quick Start. Something like:

try {
  const result = await api.generateSupermodelGraph({
    idempotencyKey: 'my-repo:supermodel:abc123',
    file,
  });
  console.log(result.graph.nodes.length, 'nodes');
} catch (error) {
  console.error('Failed to generate graph:', error);
}

Not a blocker, but it sets a good example for production code.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aba20e2 and 893074a.

📒 Files selected for processing (3)

• .github/workflows/ci.yml
• README.md
• package.json

🔇 Additional comments (7)

.github/workflows/ci.yml (1)

1-11: LGTM! Clean workflow setup.

The trigger and job configuration look solid. Triggering on both pushes and PRs to main is the right call here.

README.md (2)

8-12: Perfect! Simple and clear.

Can't get much cleaner than this for an install section.

---

38-48: Great reference section!

This table is super helpful. Having all the methods listed with descriptions makes it easy for people to discover what's available without digging through code.

package.json (4)

4-6: Confirm UNLICENSED is intentional.

You've set the license to UNLICENSED, which means the code is proprietary and nobody can use it without explicit permission. This is fine if that's what you want, but just double-check with your team.

If you meant to make this open source, you'd want something like MIT or Apache-2.0 instead. If it's intentionally private/commercial, then UNLICENSED is perfect.

---

15-28: Nice work on the keywords and files field!

The keywords will help people find your package on npm, and the files field is exactly right - you only want to ship the compiled dist folder, not all your source files. This keeps the package size small.

---

30-34: Scripts look good!

The typecheck script is a great addition - it lets you verify types without generating output files. And having prepare run the build ensures you never accidentally publish unbuild code.

The CI workflow you added will run these scripts automatically, so you're all set.

---

7-14: GitHub repository is properly configured.

The repository https://github.com/supermodeltools/typescript-sdk exists, is publicly accessible, and the URL in package.json is correct. npm will display this link without any issues.