Chore: updated sdk README

bob-collective / bob

BOB is a hybrid L2 that combines the security of Bitcoin with the versatility of Ethereum.

https://app.gobob.xyz/

81 stars 40 forks source link

Chore: updated sdk README #237

Closed bvotteler closed 5 months ago

bvotteler commented 5 months ago

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

changeset-bot[bot] commented 5 months ago

⚠️ No Changeset found

Latest commit: c8466f2f3568f578a07a9066c62a590b8a222785

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

vercel[bot] commented 5 months ago

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

derrekcoleman commented 5 months ago

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.