From 48849786c7cc09e55d3b6dc3920dbaaf9fd36822 Mon Sep 17 00:00:00 2001
From: Matus Ferech <matus.ferech@gmail.com>
Date: Sun, 5 Jul 2020 15:04:15 +0200
Subject: [PATCH] Add API reference to README

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 79ef51f..0c33b5b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Pay by square
+# PAY by square
 
 Generate codes for [by square](https://bysquare.com/) payments.
 
@@ -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