Merge pull request #237 from bob-collective/chore-update-readme

Chore: updated sdk README
bob-collective · May 14, 2024 · f709d40 · f709d40
2 parents 4d39eee + c8466f2
commit f709d40
Show file tree

Hide file tree

Showing 3 changed files with 2,556 additions and 5 deletions.
diff --git a/docs/docs/build/getting-started/helloworld.mdx b/docs/docs/build/getting-started/helloworld.mdx
@@ -572,7 +572,9 @@ export USDT_ADDRESS=0xF58de5056b7057D74f957e75bFfe865F571c3fB6
 export RPC_URL=https://testnet.rpc.gobob.xyz
 export VERIFIER_URL=https://testnet-explorer.gobob.xyz/api?
 
-forge script script/HelloBitcoin.sol --rpc-url=$RPC_URL --broadcast --verify --verifier blockscout --verifier-url=$VERIFIER_URL
+forge script script/HelloBitcoin.sol --rpc-url=$RPC_URL --broadcast \
+--verify --verifier blockscout --verifier-url=$VERIFIER_URL \
+--priority-gas-price 1
 ```
 
 The output in the terminal should look similar to this:

diff --git a/sdk/README.md b/sdk/README.md
@@ -7,18 +7,64 @@ The BOB SDK helps you interact with BOB and Bitcoin, including Ordinals, BRC20,
 - [Website](https://www.gobob.xyz/)
 - [Docs](https://docs.gobob.xyz/)
 
-## Installation
+## Using the sdk in your project
+Install `@gobob/bob-sdk` with your package manager of choice.
 
 ```shell
-pnpm i @bob-sdk/sdk
+pnpm i @gobob/bob-sdk
 ```
 
-## Test
+or
+```shell
+yarn add @gobob/bob-sdk
+```
+
+or
+```shell
+npm i @gobob/bob-sdk
+```
+
+## Building BOB sdk
+
+### Clone the repository
+Clone the repository and change to the `sdk` subfolder.
+```shell
+git clone [email protected]:bob-collective/bob.git
+cd bob/sdk
+```
+
+### Install dependencies
+We use `pnpm` in the examples below. But the steps below should also work when using `yarn` or `npm` instead.
+
+```shell
+pnpm i
+```
+
+### Build
+```shell
+pnpm build
+```
+
+### Test
 
 ```shell
 pnpm test
 ```
 
 ## Contributing
 
-BOB is an open-source project. We welcome contributions of all sorts. There are many ways to help, from reporting issues, contributing code, and helping us improve our community.
+BOB is an open-source project. We welcome contributions of all sorts. There are many ways to help, from reporting issues, contributing code, and helping us improve our community.  
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
+
+1. Set up git so you can [sign your commits](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) (Alternative link: [GitHub: Signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits))  
+Unsigned PRs cannot be merged, so do not skip this step.
+2. Fork the Project
+3. Create your Feature Branch (git checkout -b yourname/AmazingFeature)
+4. Commit your Changes (git commit -m 'Add some AmazingFeature')
+5. Push to the Branch (git push origin yourname/AmazingFeature)
+6. Open a Pull Request with a description of feature you are adding
+
+If you are searching for a place to start or would like to discuss features, reach out to us:
+
+- [Discord](https://discord.com/invite/gobob)
+