diff --git a/README.md b/README.md index a9f0763..691f6dc 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # Zappier -Metered API platform: per-endpoint pricing, customer types with multipliers and -monthly credits, a usage ledger, Stripe metered billing, purchase-order -invoicing, a company admin console, a self-service customer portal, and a -Zapier integration. +[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme) + +Metered API platform: per-endpoint pricing, customer types with multipliers and monthly credits, a usage ledger,... This is the **billing and user platform** (originally the standalone `zappier` git tree at `~/zappier`). Forgejo name: **zappier-edge**. It owns signup, TOTP, API keys, rate card, Stripe meter, PO invoices, admin users, and the customer portal. Verae middleware does not replace this. @@ -140,3 +139,32 @@ To deploy it, create a Zapier developer account, run `zapier login`, then npm test # root API/service suite (jest, 165 tests) cd zapier-app && npm test # Zapier integration suite (mocha, 4 tests) ``` + +## Table of Contents + +- [Install](#install) +- [Usage](#usage) +- [Contributing](#contributing) +- [License](#license) + +## Install + +```sh +git clone ssh://git@git.georgelambert.org:2223/marchon/zappier-edge.git +cd zappier-edge +``` + +## Usage + +```sh +npm install +npm start +``` + +## Contributing + +Questions: open an issue at https://git.georgelambert.org/marchon/zappier-edge/issues. Pull requests are accepted. + +## License + +UNLICENSED © George Lambert