Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add installation and quick start to readme #1537

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Conversation

mrlubos
Copy link
Member

@mrlubos mrlubos commented Jan 8, 2025

Closes #1491

Copy link

stackblitz bot commented Jan 8, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Jan 8, 2025

⚠️ No Changeset found

Latest commit: a267462

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@mrlubos mrlubos marked this pull request as ready for review January 8, 2025 09:36
Copy link

vercel bot commented Jan 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hey-api-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2025 9:39am

Copy link

codecov bot commented Jan 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.25%. Comparing base (13eea59) to head (a267462).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1537   +/-   ##
=======================================
  Coverage   59.25%   59.25%           
=======================================
  Files         158      158           
  Lines       24737    24737           
  Branches     1887     1887           
=======================================
  Hits        14657    14657           
  Misses      10073    10073           
  Partials        7        7           
Flag Coverage Δ
unittests 59.25% <ø> (ø)

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.

Copy link

pkg-pr-new bot commented Jan 8, 2025

Open in Stackblitz

npm i https://pkg.pr.new/@hey-api/client-axios@1537
npm i https://pkg.pr.new/@hey-api/openapi-ts@1537
npm i https://pkg.pr.new/@hey-api/client-fetch@1537

commit: a267462

@mrlubos mrlubos merged commit 729598c into main Jan 8, 2025
17 checks passed
@mrlubos mrlubos deleted the docs/readme branch January 8, 2025 09:47
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.

Update README
1 participant