Merge pull request #3 from bunq/feature/test_readme

Added tests readme

Author: dnl-blkv

README.md

@@ -1,5 +1,4 @@
 # bunq Java SDK
-Version 0.9.0 **BETA**
 
 ## Introduction
 Hi developers!
@@ -169,3 +168,7 @@ IDE.
 
 Please do not forget to set the `API_KEY` constant in `ApiContextSaveExample.java` to your actual
 API key before running the example!
+
+## Running tests
+Information regarding the test cases can be found in the [README.md](./src/test/README.md)
+located in [test](/src/test).

src/test/README.md

@@ -0,0 +1,39 @@
+# bunq Java SDK
+
+## Introduction
+Hi developers!
+
+Welcome to the bunq Java SDK integration tests. Currently we are not
+targeting the 100% test coverage, but rather want to be certain that the most
+common scenarios can run without any errors.
+
+## Scenarios 
+These are the scenarios that are currently being tested:
+* Create installation, session-server and device server
+* Create a new MonetaryAccount
+* Create a tab
+* Update the tab
+* Create attachment and avatar
+* Request money from first MA to second MA
+* Accept the request
+* Make a transaction from first MA to second MA
+* Create connect gr code
+* Make a payment to another sandbox user
+* Send a chat message in a recent payment
+* Delete the current session
+* Order a card with a second line
+
+Besides these scenarios, some code of ApiContext, ApiClient and the JSON module 
+are also tested :thumbs_up:.
+
+## Configuration
+To run the tests you must first setup the test configuration JSON. The example
+of a configuration file is located at [`src/test/config.example.properties`](./config.example.properties).
+In order to make use of the configuration file, please copy the example to the
+same directory, fill in your sandbox user data and rename the copy to `config.properties`.
+
+## Execution
+To run tests via IntelliJ IDEA, you must make sure that you've build the project with gradle.
+
+Afterwards you can right click on the tests folders and should be able to run
+the tests cases form the IDE.