docs: bring README.md in line with Standard Readme

This commit is contained in:
George Lambert 2026-09-22 09:58:30 -04:00
commit 5d45416037

View file

@ -1,6 +1,8 @@
# zappier-account-balance
Source of truth for **customer prepaid balances** (persisted `books.json`). Internal traffic is **NATS request-reply**; HTTP is health plus a fallback. zappier-edge `balanceCents` is a cache of this book.
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
Source of truth for **customer prepaid balances** (persisted `books.json`). Internal traffic is **NATS...
**Forgejo:** https://git.georgelambert.org/marchon/zappier-account-balance
**Catalog:** https://zapier.georgelambert.org/packages/zappier-account-balance/README.pdf
@ -29,3 +31,25 @@ curl http://127.0.0.1:3010/statement/cust_1
```
Statement JSON: `{ customerId, prepaidCents, credits[], usage[], payments[] }`.
## Install
```sh
git clone ssh://git@git.georgelambert.org:2223/marchon/zappier-account-balance.git
cd zappier-account-balance
```
## Usage
```sh
npm install
npm start
```
## Contributing
Questions: open an issue at https://git.georgelambert.org/marchon/zappier-account-balance/issues. Pull requests are accepted.
## License
UNLICENSED © George Lambert