docs: add Quick Start section with npm installation and AI instructions

[TheEagleByte]

Summary

• Add Quick Start section at top of README with npm package and source installation options
• Add copy-pasteable AI instructions snippet for system prompts
• Update package name to @eaglebyte/skylight-mcp and bump to v1.1.0
• Remove outdated sections (Known Limitations, redundant Claude Desktop usage)

Test plan

• Verify README renders correctly on GitHub
• Test npx @eaglebyte/skylight-mcp after publishing
• Copy AI instructions to Claude and verify it understands Skylight context

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation

  • Expanded Quick Start guide with multiple installation options (npm package and from source).
  • Added comprehensive Configuration section with environment variables table.
  • Enhanced authentication documentation with email/password and token-based methods.
  • Added Frame ID lookup instructions.

• Chores

  • Updated package name and version.
  • Configured distribution files in manifest.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation is restructured from prerequisites to a comprehensive quick-start guide with installation options, environment configuration, and AI interaction instructions. Package metadata is updated: name changes to @eaglebyte/skylight-mcp, version bumps to 1.1.0, and a files manifest is added.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Restructured from minimal prerequisites to comprehensive quick-start guide; added dual installation paths (npm and source), mcp.json configurations, environment variables, authentication methods, Frame ID lookup steps, and AI interaction instructions; removed desktop integration and known limitations sections
Package Manifest package.json	Updated package name to @eaglebyte/skylight-mcp, version to 1.1.0, and added files array specifying dist, README.md, and LICENSE for publication

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Quick-start hops and configs grow,
Package names in new light glow,
Skylight rebranded, polished bright,
Documentation shining pure delight! ✨

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 accurately summarizes the main changes: adding a Quick Start section with npm installation options and AI instructions to the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 51924ce and 576f8ef.

📒 Files selected for processing (2)

• README.md
• package.json

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-12-29T21:36:49.327Z

Learnt from: CR
Repo: TheEagleByte/skylight-mcp PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T21:36:49.327Z
Learning: Set timezone to America/New_York by default, configurable via SKYLIGHT_TIMEZONE environment variable

Applied to files:

• README.md

🔇 Additional comments (7)

README.md (6)

45-67: Clear from-source installation instructions.

The from-source installation option is well-documented with proper build steps and configuration examples. The placeholder path clearly indicates where users need to substitute their actual installation path.

---

120-130: Configuration table accurately documents defaults and requirements.

The configuration table is well-structured and correctly documents SKYLIGHT_TIMEZONE defaulting to America/New_York, which aligns with the project's established configuration. The distinction between required and optional variables is clear.

Based on learnings, the timezone default is correctly documented.

---

21-35: JSON configuration examples are syntactically correct.

The mcp.json examples for both installation options are properly formatted with valid JSON syntax and appropriate structure for MCP server configuration.

Also applies to: 53-66

---

14-80: Excellent Quick Start documentation with clear installation paths.

The Quick Start section effectively serves its purpose by providing:

• Multiple installation options (npm and from-source)
• Copy-pasteable configuration for different environments
• Clear AI integration instructions
• Proper progression from setup to usage

This is a significant improvement in user experience for getting started with the MCP server.

---

18-43: Package is already published on npm—no action needed.

The @eaglebyte/skylight-mcp package is published on npm (version 1.0.0 as of 2025-12-29) and users can use npx @eaglebyte/skylight-mcp immediately as shown in the README.

Likely an incorrect or invalid review comment.

---

37-43: Fix Claude Code MCP command syntax: use --env not -e and add -- separator.

The claude mcp add command uses --env KEY=value flags (not -e) and requires -- to separate CLI flags from the MCP server command. The correct syntax is:

claude mcp add skylight --env SKYLIGHT_EMAIL=your_email@example.com \
  --env SKYLIGHT_PASSWORD=your_password \
  --env SKYLIGHT_FRAME_ID=your_frame_id \
  -- npx @eaglebyte/skylight-mcp

⛔ Skipped due to learnings

Learnt from: CR
Repo: TheEagleByte/skylight-mcp PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-29T21:36:49.327Z
Learning: Require SKYLIGHT_FRAME_ID environment variable as household identifier from API URLs

package.json (1)

10-14: The LICENSE file exists in the repository root, so no action is needed.