Merge pull request #2 from bunq/feature/test_readme

Added readme for tests

Author: dnl-blkv

BunqSdk.Tests/README.md

@@ -0,0 +1,37 @@
+# bunq C# 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 [`Tests/BunqSdkCsharpTest/Resources/config.example.json`](./BunqSdkCsharpTest/Resources/config.example.json).
+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.json`.
+
+## Execution
+To run tests via Rider, you can right click on the `BunqSdk.Tests` solution and should be able to run
+the tests cases form the IDE.

README.md

@@ -6,7 +6,7 @@ Hi developers!
 
 Welcome to the bunq C# SDK! 👨‍💻
 
-We're very happy to introduce yet another unique product: complete banking SDKs! 
+We're very happy to introduce yet another unique product: complete banking SDKs!
 Now you can build even bigger and better apps and integrate them with your bank of the free! 🌈
 
 Before you dive into this brand new SDK, please consider:
@@ -18,7 +18,7 @@ questions and experience 🎤
 Give us your feedback, create pull requests, build your very own bunq apps and most importantly:
 have fun! 💪
 
-This SDK is in **beta**. We cannot guarantee constant availability or stability. 
+This SDK is in **beta**. We cannot guarantee constant availability or stability.
 Thanks to your feedback we will make improvements on it.
 
 ## Installation
@@ -106,7 +106,7 @@ var monetaryAccount = MonetaryAccount.Get(apiContext, USER_ITEM_ID, MONETARY_ACC
 See [`MonetaryAccountSample.cs`](./BunqSdk.Samples/MonetaryAccountSample.cs)
 
 #### Updating objects
-Updating objects through the API goes the same way as creating objects, except that also the object to update identifier 
+Updating objects through the API goes the same way as creating objects, except that also the object to update identifier
 (ID or UUID) is needed.
 
 ```
@@ -172,3 +172,7 @@ $ dotnet run ApiContextSaveSample.cs
 
 Please do not forget to set the `API_KEY` constant in `ApiContextSaveSample.cs` to your actual API key before running the
 sample!
+
+## Running tests
+Information regarding the test cases can be found in the [README.md](./BunqSdk.Tests/README.md)
+located in [test](./BunqSdk.Tests).