Update README.md

This commit is contained in:
ryanchanplc 2020-10-20 14:56:42 +08:00 committed by GitHub
parent da37fcfb6e
commit 20105213a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,9 +1,12 @@
NOTE: this package only support FPS ID (MerchantID), it doesnt support mobile number / email as recipient identifier. The mobile number is just a field in Additional Data in CommonQR Code Specification.
## node-hk-fps
A Nodejs module that help to generate QR code content string of the Hong Kong Faster Payment System. Please refer the [blog](https://medium.com/@ryanchanplc/understanding-the-qr-code-used-in-hong-kong-faster-payment-system-6cc1671405d2)
**NOTE: this package only support FPS ID (MerchantID), it doesnt support mobile number / email as recipient identifier. The mobile number is just a field in Additional Data in CommonQR Code Specification.**
## Installation
Install with npm