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

Chore: updated sdk README #237

Merged
merged 4 commits into from
May 14, 2024
Merged

Chore: updated sdk README #237

merged 4 commits into from
May 14, 2024

Conversation

bvotteler
Copy link
Contributor

@bvotteler bvotteler commented May 8, 2024

Resolves #178

Updated README with the following changes

  • updated install instructions
  • fixed outdated npm package name
  • more clearly separated instructions as a consumer of the sdk vs building
  • added contributing section

Bonus:

  • added package-lock.json to stop CI's SDK test step from failing
  • added missing parameter in one of Hello Bitcoin's commands

@bvotteler bvotteler requested a review from derrekcoleman May 8, 2024 04:51
Copy link

changeset-bot bot commented May 8, 2024

⚠️ No Changeset found

Latest commit: c8466f2

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.

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

Copy link

vercel bot commented May 8, 2024

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

Name Status Preview Comments Updated (UTC)
bob ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 14, 2024 9:03am

@bvotteler bvotteler requested a review from nud3l May 8, 2024 04:51
@derrekcoleman
Copy link
Contributor

Thank you! Agreed with all of your adds to the language in the README. I know we'll all appreciate the SDK CI passing from now on, too.

@nud3l, please merge.

@nud3l nud3l merged commit f709d40 into master May 14, 2024
3 of 4 checks passed
@nud3l nud3l deleted the chore-update-readme branch May 14, 2024 09:01
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.

Add install instructions for BOB SDK to docs
3 participants