ref: readme and .env.example

lfglabs-dev · Feb 4, 2025 · a4c8472 · a4c8472
1 parent 3bb30c2
commit a4c8472
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,7 @@
+# Bitcoin RPC credentials
+BITCOIN_RPC_URL="http://localhost:8332"
+BITCOIN_RPC_USER="your-rpc-username"
+BITCOIN_RPC_PASS="your-rpc-password"
+
+# Starknet provider configuration
+STARKNET_PROVIDER_URL="your-starknet-provider-url"
diff --git a/README.md b/README.md
@@ -16,13 +16,26 @@ npm install bitcoin-on-starknet
 
 ## Usage
 
+Before using the library, make sure to set up your environment variables in a `.env` file:
+
+```bash
+# Bitcoin RPC credentials
+BITCOIN_RPC_URL="http://localhost:8332"
+BITCOIN_RPC_USER="your-rpc-username"
+BITCOIN_RPC_PASS="your-rpc-password"
+
+# Starknet provider configuration
+STARKNET_PROVIDER_URL="your-starknet-provider-url"
+```
+
 ## Testing
 
 ```bash
 bun run test
 ```
 
 ## Building
+
 ```bash
-bun run build 
+bun run build
 ```