From: Raphael Michel <mail@raphaelmichel.de>
Date: Mon, 2 Jan 2017 18:18:15 +0000 (+0100)
Subject: Add README and requirements
X-Git-Tag: v0.1.0~7
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cb689b74c2c34c0bbe2772f0bc440002085b3d26;p=thirdparty%2Fpython-fints.git

Add README and requirements
---

diff --git a/README.md b/README.md
index ba1818d..1c5a0a9 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,40 @@
-Inspiration from https://github.com/barnslig/fints4fun
+PyFinTS
+=======
 
-Only FinTS 3.0 supported at the moment, only reading data and only PIN/TAN
+This is a pure-python implementation of FinTS (formerly known as HBCI), a
+online-banking protocol commonly supported by German banks.
+
+Limitations
+-----------
+
+* Only FinTS 3.0 is supported
+* Only PIN/TAN authentication is supported, no signature cards
+* Only a number of reading operations are currently supported
+
+Usage
+-----
+
+    import logging
+    from fints3.client import FinTS3PinTanClient
+
+    logging.basicConfig(level=logging.DEBUG)
+    f = FinTS3PinTanClient(
+        '123456789',  # Your bank's BLZ
+        'myusername',
+        'mypin',
+        'https://mybank.com/…'  # endpoint, e.g.: https://hbci-pintan.gad.de/cgi-bin/hbciservlet
+    )
+
+    print(f.get_sepa_accounts())
+
+
+Credits and License
+-------------------
+
+Author: Raphael Michel <mail@raphaelmichel.de>
+
+License: LGPL
+
+This is a quite close port of the [fints-hbci-php](https://github.com/mschindler83/fints-hbci-php)
+implementation that was released by Markus Schindler under the MIT license.
+Thanks for your work!
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..3288e92
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+requests
+