aljaz/payments-rest-api
1
0
Fork 0
mirror of https://github.com/aljazceru/payments-rest-api.git synced 2025-12-18 14:14:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
Aljaz Ceru
2025-06-13 16:42:27 +02:00
parent e6c30741c7
commit e980410a6e
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,5 +1,12 @@
# Breez Payments REST API
Breez Payments Rest API is a REST API on top of [Breez Nodeless SDK](https://github.com/breez/breez-sdk-liquid) build with fastapi. It enables integrations like [breez-woocommerce](https://github.com/breez/breez-woocommerce). It is built to be easily deployable anywhere, with support for providers with free tier like [fly.io](./fly/README.md).
Breez Payments Rest API is a REST API on top of [Breez Nodeless SDK](https://github.com/breez/breez-sdk-liquid) build with fastapi. It enables integrations like [breez-woocommerce](https://github.com/breez/breez-woocommerce). It is built to be easily deployable anywhere you want.
## Deployment options
- [fly.io](./docs/FLY.md) - deploy fly.io app on their free tier hosting
- [render.com](./docs/RENDER.md) - deploy to render.com with a free tier hosting
- [self hosted](./docs/DEV.md) - deploy anywhere you want with a simple docker deployment
## API documentation
OpenAPI documentation is generated on every instance at ```<api-url>/docs```. It can also be downloaded [here](./openapi.json).
@@ -8,7 +15,3 @@ OpenAPI documentation is generated on every instance at ```<api-url>/docs```. It
X-API-KEY header serves as authorization method for accessing the API. Anyone that knows the API url and API_SECRET can access your funds, so make sure to protect this secret and to generate a unique and long string. You can use generators like [this](https://1password.com/password-generator) or [this](https://www.uuidgenerator.net/).
## Deployment options
- [fly.io](./fly/README.md) - deploy fly.io app on their free tier hosting
- [self hosted](./fly/DEV.md) - deploy anywhere you want with a simple docker deployment