Skip to content

chore: update readme#61

Merged
dutterbutter merged 2 commits intomainfrom
db/update-ui-readmes
Oct 30, 2025
Merged

chore: update readme#61
dutterbutter merged 2 commits intomainfrom
db/update-ui-readmes

Conversation

@dutterbutter
Copy link
Owner

What 💻

  • Adds run instructions for ui-examples

Why ✋

  • Instructions are good

Evidence 📷

Include screenshots, screen recordings, or console output here demonstrating that your changes work as intended

Copilot AI review requested due to automatic review settings October 30, 2025 18:52
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes StackBlitz integration links and replaces them with simplified setup instructions for running the UI examples locally. The changes standardize the README files across multiple example directories by providing consistent documentation for local development.

  • Removed StackBlitz "Open in StackBlitz" badges from all UI example READMEs
  • Added clear setup instructions with bun install and bun run dev commands
  • Standardized documentation format across viem and ethers examples

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
examples/viem/ui-examples/withdrawals/README.md Replaced StackBlitz badge with local setup instructions for viem withdrawals example
examples/viem/ui-examples/deposits/README.md Replaced StackBlitz badge with local setup instructions for viem deposits example
examples/ethers/ui-examples/withdrawals/README.md Replaced StackBlitz badge with local setup instructions for ethers withdrawals example
examples/ethers/ui-examples/deposits/README.md Replaced StackBlitz badge with local setup instructions for ethers deposits example

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Oct 30, 2025

ci-run-tests LCOV of commit 94f49a4 during ci-run-tests #167

Summary coverage rate:
  lines......: 85.9% (9989 of 11624 lines)
  functions..: no data found
  branches...: no data found

Files changed coverage rate: n/a

@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.93%. Comparing base (2368f8a) to head (94f49a4).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #61   +/-   ##
=======================================
  Coverage   85.93%   85.93%           
=======================================
  Files          75       75           
  Lines       11624    11624           
=======================================
  Hits         9989     9989           
  Misses       1635     1635           
Flag Coverage Δ
combined 85.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dutterbutter dutterbutter merged commit 7a2b368 into main Oct 30, 2025
6 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