More docs

README.md

@@ -1,7 +1,5 @@
 # Satsbox
 
-Under development, datasheets may not support upgrades.
-
 Nostr friendly bitcoin lightning custodial wallet service.
 
 ## Features
@@ -14,3 +12,47 @@ Nostr friendly bitcoin lightning custodial wallet service.
 - [LndHub](https://github.com/BlueWallet/LndHub) api compatible
 - Supported backends: [LND](https://github.com/lightningnetwork/lnd) and [CLN](https://github.com/ElementsProject/lightning) 23.08+
 - Easily create private non-custodial multi-account wallet service by setting up whitelist
+
+## Usage
+
+### Requirement
+
+[LND](https://github.com/lightningnetwork/lnd) or [CLN](https://github.com/ElementsProject/lightning) 23.08+
+
+### Docker
+
+```shell
+
+# Create data dir
+mkdir ./data
+# Refer to satsbox.example.toml edit configuration file
+touch satsbox.toml
+
+docker run -it --rm -p 8080:8080 \
+  --user=$(id -u) \
+  -v $(pwd)/data:/satsbox/data \
+  -v $(pwd)/satsbox.toml:/satsbox/satsbox.toml \
+  --name satsbox rnostr/satsbox:latest
+
+```
+
+## Development
+
+```shell
+
+git clone https://github.com/rnostr/satsbox.git
+
+# start dependencies
+cd satsbox/contrib
+docker compose up -d
+
+# init regtest lightning network
+sh dev.sh test
+
+# copy cert file from docker to local
+sh dev.sh copy_cert
+
+# run test
+cargo test
+
+```

satsbox.example.toml

@@ -56,14 +56,14 @@ secret = "test"
 
 # config lnurl
 [lnurl]
-# The nostr privkey for send zap receipts
+# The nostr privkey for send zap receipts, if not set, the zaps feature will be disabled.
 privkey = "c267c52ca60b4d6553891ad201eebda3af21addcedb62bf624c942413a0ced46"
 # Additional relays for send zap receipts
 relays = ["ws://127.0.0.1:8777", "ws://127.0.0.1:8880"]
 
 # config nwc
 [nwc]
-# The nostr privkey for interacting with users
+# The nostr privkey for interacting with users, if not set, the nwc feature will be disabled.
 privkey = "c267c52ca60b4d6553891ad201eebda3af21addcedb62bf624c942413a0ced46"
 # The nostr relays for interacting with users
 relays = ["ws://127.0.0.1:8777", "ws://127.0.0.1:8880"]
@@ -83,7 +83,7 @@ port = 8080
 
 # config donation
 [donation]
-# account privkey for receive donation
+# account privkey for receive donation, if not set, the donation feature will be disabled.
 privkey = "c267c52ca60b4d6553891ad201eebda3af21addcedb62bf624c942413a0ced46"
 # recommended donation amounts
 amounts = [1000000, 10000000, 100000000]