Skip to content

docs: add demo app link to README#16

Merged
NamanGarg20 merged 4 commits intomainfrom
jacob/demo-readme
Feb 17, 2026
Merged

docs: add demo app link to README#16
NamanGarg20 merged 4 commits intomainfrom
jacob/demo-readme

Conversation

@JacobFV
Copy link
Contributor

@JacobFV JacobFV commented Feb 13, 2026

Summary

Test plan

  • README renders correctly on GitHub

🤖 Generated with Claude Code

Greptile Summary

Added a "Demo App" section to the README linking to the agi-inc/demo-node-electron repository, which provides an interactive Electron GUI for showcasing SDK capabilities. Also added a new comprehensive quickstart example (quickstart-remote.ts) demonstrating both low-level and high-level APIs.

  • Added Demo App section with GitHub link and setup instructions
  • Created examples/basic/quickstart-remote.ts showing session management, event streaming, screenshots, pause/resume controls, and automatic cleanup
  • Applied prettier formatting to maintain code style consistency

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only changes that add helpful resources for users. The new example file follows existing conventions and demonstrates proper SDK usage with correct syntax. All changes are non-breaking additions.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Added a "Demo App" section linking to demo-node-electron repository with setup instructions
examples/basic/quickstart-remote.ts New comprehensive example demonstrating low-level and high-level SDK APIs with session management, event streaming, and cleanup

Last reviewed commit: 710a764

- Added demo app links and descriptions to README
- Added examples/quickstart.ipynb demonstrating remote browser agent
  usage with tslab kernel: create session, send task with streaming,
  screenshots, session control, and high-level API

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

JacobFV and others added 3 commits February 16, 2026 14:05
`await using const` is not valid syntax per TC39 Explicit Resource
Management proposal. Changed to `await using session = ...`.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ript

Removed examples/quickstart.ipynb and added examples/basic/quickstart-remote.ts
to match existing example conventions. Covers the same content: session creation,
task streaming, screenshots, pause/resume, cleanup, and high-level API.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Contributor

@NamanGarg20 NamanGarg20 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@NamanGarg20 NamanGarg20 merged commit 035c108 into main Feb 17, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments