GlcoinCore/alby-hub
1
0
Fork 0
mirror of https://github.com/getAlby/hub.git synced 2026-08-13 12:33:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

update readme

Browse source
This commit is contained in:
kiwiidb 2023-08-03 13:29:43 +02:00
parent c1f5a3f5bf
commit 4002cfb90f
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -71,7 +71,7 @@ Example:
#### Client created secret
If the client creates the secret the client only needs to share the public key of that secret for authorization. The user authorized that pubkey and no sensitivate data needs to be shared.
##### Query parameter options
##### Query parameter options for /new
- `c`: the name of the client app
- `pubkey`: the public key of the client's secret for the user to authorize
- `return_to`: (optional) if a `return_to` URL is provided the user will be redirected to that URL after authorization. The `lud16`, `relay` and `pubkey` query parameters will be added to the URL.
@ -79,6 +79,7 @@ If the client creates the secret the client only needs to share the public key o
- `max_amount` (optional) maximum amount in sats that can be sent per renewal period
- `budget_renewal` (optional) reset the budget at the end of the given budget renewal. Can be `never` (default), `daily`, `weekly`, `monthly`, `yearly`
- `editable` (optional) set to `false` to disable form editing by the user
- `request_methods` (optional) url encoded, space seperated list of request types that you need permission for: `pay_invoice` (default), `get_balance` (see NIP47)
Example: