Skip to content

Commit

Permalink
Add API reference to README
Browse files Browse the repository at this point in the history
  • Loading branch information
matusf committed Jul 5, 2020
1 parent cfe0956 commit 4884978
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pay by square
# PAY by square

Generate codes for [by square](https://bysquare.com/) payments.

Expand All @@ -14,6 +14,31 @@ pip install pay-by-square

## Usage

### API

```text
pay_by_square.generate(
*,
amount: float,
iban: str,
swift: str = '',
date: Optional[date] = None,
beneficiary_name: str = '',
currency: str = 'EUR',
variable_symbol: str = '',
constant_symbol: str = '',
specific_symbol: str = '',
note: str = '',
beneficiary_address_1: str = '',
beneficiary_address_2: str = '',
) -> str:
Generate pay-by-square code that can by used to create QR code for banking apps
When date is not provided current date will be used.
```

### Example

```python
import qrcode
import pay_by_square
Expand Down

0 comments on commit 4884978

Please sign in to comment.