diff --git a/README.md b/README.md index 3b31a53..7cf93b6 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,18 @@ pip install -r requirements.txt --extra-index-url=https://pip.grassrootseconomic pip3 install -UI --extra-index-url=https://pip.grassrootseconomics.net clicada ``` +### GPG Keyring setup + +PGP uses the default keyring, you can however pass in a custom keyring path. + +To create a keyring from a specific key and get its path for `AUTH_KEYRING_PATH`: + +```bash +# In some dir +gpg --homedir .gnupg --import private.pgp +pwd +``` + ### Usage ```bash @@ -67,3 +79,9 @@ optional arguments: override fee limit ``` + +### Example + +```bash +AUTH_PASSPHRASE=queenmarlena AUTH_KEYRING_PATH=/home/kamikaze/grassroots/usumbufu/tests/testdata/pgp/.gnupg/ AUTH_KEY=CCE2E1D2D0E36ADE0405E2D0995BB21816313BD5 CHAIN_SPEC=evm:byzantium:8996:bloxberg CIC_REGISTRY_ADDRESS=0xcf60ebc445b636a5ab787f9e8bc465a2a3ef8299 RPC_PROVIDER=https://rpc.grassecon.net TX_CACHE_URL=https://cache.grassecon.net HTTP_CORS_ORIGIN=https://auth.grassecon.net META_HTTP_ORIGIN=https://auth.grassecon.net:443 PYTHONPATH=. python clicada/runnable/view.py u --meta-url https://auth.grassecon.net +254711000000 +```