Merge pull request #359 from gini/update-readmes

Update readmes

bank-api-library/README.md

@@ -22,8 +22,7 @@ Dependencies
 
 The Gini Bank API Library has the following dependencies:
 
-* [Volley from Google](https://developer.android.com/training/volley/index.html) ([AOSP Repository](https://android.googlesource.com/platform/frameworks/volley))
-* [Bolts from facebook](https://github.com/BoltsFramework/Bolts-Android)
+* [Retrofit2](https://square.github.io/retrofit/)
 * [TrustKit from DataTheorem](https://github.com/datatheorem/TrustKit-Android)
 
 License

bank-sdk/README.md

@@ -7,30 +7,24 @@ The Gini Bank SDK for Android provides all the UI and functionality needed to us
 extract payment information from invoices and to resolve payment requests originating from other apps.
 
 The Gini Bank API provides an information extraction service for analyzing invoices. Specifically it extracts information
-such as the document sender or the payment relevant information (amount to pay, IBAN, etc.). In addition it also
+such as the document sender or the payment relevant information (amount to pay, IBAN, etc.). In addition, it also
 provides a secure channel for sharing payment related information between clients.
 
 Documentation
 -------------
-* [Integration Guide](https://developer.gini.net/gini-mobile-android/bank-sdk/sdk/html/)
+* [Integration Guide](https://gini.atlassian.net/wiki/spaces/GBSV/overview)
 * [Reference Docs](https://developer.gini.net/gini-mobile-android/bank-sdk/sdk/dokka/index.html)
 
 Examples
 --------
 
 ## Invoice Capture
 
-We are providing example apps for the Screen API and the Component API. These apps demonstrate how
-to integrate the Gini Pay Bank SDK's invoice capture feature:
-
-You can find the example apps in the following modules:
-
-- `screen-api-example-app` for the Screen API
-- `component-api-example-app` for the Component API
+We are providing an example app in the `:bank-sdk:example-app` module, which demonstrates how to integrate the Gini Bank SDK's invoice capture feature.
 
 ## Payment Requests
 
-You can find an example on how to handle payment requests in the `screen-api-example-app` module's `PayActivity`. 
+You can find an example on how to handle payment requests in the example app's `PayActivity`. 
 
 For testing the payment flow integration you can use the example app from the [Health
 SDK](https://github.com/gini/gini-mobile-android/tree/main/health-sdk#example-apps) to create payment requests.

bank-sdk/example-app/README.md

@@ -1,73 +1,23 @@
-Screen API Example App
+Gini Bank SDK Example App
 =========================
 
-This example app provides you with a sample usage of the Gini Capture SDK's Screen API.
+This example app provides you with a sample usage of the Gini Bank SDK.
 
 The Gini Bank API Library is used for analyzing documents and sending feedback.
 
-Before analyzing documents with the Screen API example app, you need to set your Gini Bank API client id and secret by creating a
+Before analyzing documents with the Gini Bank SDK example app, you need to set your Gini Bank API client id and secret by creating a
 `local.properties` file in this folder containing a `clientId` and a `clientSecret` property.
 
-You can find more information about the Screen API in our [integration guide](https://developer.gini.net/gini-mobile-android/capture-sdk/sdk/html/integration.html#screen-api).
-
-Overview
-========
-
-The entry point of the app is the `MainActivity`. It starts the Gini Capture SDK and handles the result.
-
-You only need to configure and create a `GiniCapture` instance and start the 
-`CameraActivity` for result.
-
-ExtractionsActivity
--------------------
-
-Displays the extractions with the possibility to send feedback to the Gini API. It only shows the extractions needed for transactions, we
-call them the Pay5: payment recipient, IBAN, BIC, amount and payment reference.
-
-Feedback should be sent only for the user visible fields. Other fields should be filtered out.
-
-NoExtractionsActivity
----------------------
-
-Displays tips to the user, if no Pay5 extractions were found. 
-
-We recommend implementing a similar screen to aid the user in the taking better pictures and improve the quality of the extractions.
-
-Gini Bank API Library
-====================
-
-The Gini Bank API Library is not used directly. The default networking plugin, which was used when configuring and creating a `GiniCapture` instance,
-takes care of communicating with the Gini Bank API.
-
-Customization
-=============
-
-Customization options are detailed in each Screen API Activity's javadoc: `CameraActivity`, `HelpActivity`, `OnboardingActivity`,
-`ReviewActivity` and `AnalysisActivity`.
-
-To experiment with customizing the images used in the Gini Capture SDK you can copy the contents of the folder
-`screenapiexample/customized-drawables` to `screenapiexample/src/main/res`.
-
-Text customizations can be tried out by uncommenting and modifying the string resources in the
-`screenapiexample/src/main/res/values/strings.xml`.
-
-Text styles and fonts can be customized by uncommenting and altering the styles in the `screenapiexample/src/main/res/values/styles.xml`
-
-To customize the colors you can uncomment and modify the color resources in the `screenapiexample/src/main/res/values/colors.xml`.
-
-Customizing the opacity of the onboarding pages' background you can uncomment and modify the string resource in the
-`screenapiexample/src/main/res/values/config.xml`.
-
 ProGuard 
-======== 
+========
 
-A sample ProGuard configuration file is included in the Screen API example app's directory called `proguard-rules.pro`. 
+A sample ProGuard configuration file is included in the example app's directory called `proguard-rules.pro`. 
 
 The release build is configured to run ProGuard. You need a keystore with a key to sign it. Create a keystore with a key and provide them in
 the `gradle.properties` or as arguments for the build command:
 
 ``` 
-$ ./gradlew screenapiexample::assembleRelease \ 
+$ ./gradlew bank-sdk:example-app:assembleRelease \ 
     -PreleaseKeystoreFile=<path to keystore> \ 
     -PreleaseKeystorePassword=<keystore password> \ 
     -PreleaseKeyAlias=<key alias> \ 

capture-sdk/README.md

@@ -14,17 +14,10 @@ IBAN, BIC, payment reference, etc.) in an invoice.
 Documentation
 -------------
 
-* [Integration Guide](https://developer.gini.net/gini-mobile-android/capture-sdk/sdk/html/) and
+* [Integration Guide](https://gini.atlassian.net/wiki/spaces/SCSV/overview)
 * [Gini Capture Reference Docs](https://developer.gini.net/gini-mobile-android/capture-sdk/sdk/dokka/index.html)
 * [Network Library Reference Docs](https://developer.gini.net/gini-mobile-android/capture-sdk/default-network/dokka/index.html)
 
-Examples
---------
-
-We are providing example apps for the Screen API and the Component API. These apps demonstrate how
-to integrate the Gini Capture SDK and how to use it with the Gini Capture Network Library to
-analyze photos of documents.
-
 License
 -------
 

capture-sdk/default-network/README.md

@@ -16,7 +16,6 @@ creating a new `GiniCapture`.
 Documentation
 -------------
 
-* [Integration Guide](https://developer.gini.net/gini-mobile-android/capture-sdk/default-network/html/) and
 * [Default Network Library Reference Docs](https://developer.gini.net/gini-mobile-android/capture-sdk/default-network/dokka/index.html)
 
 Example

health-api-library/README.md

@@ -22,8 +22,7 @@ Dependencies
 
 The Gini Health API Library has the following dependencies:
 
-* [Volley from Google](https://developer.android.com/training/volley/index.html) ([AOSP Repository](https://android.googlesource.com/platform/frameworks/volley))
-* [Bolts from facebook](https://github.com/BoltsFramework/Bolts-Android)
+* [Retrofit2](https://square.github.io/retrofit/)
 * [TrustKit from DataTheorem](https://github.com/datatheorem/TrustKit-Android)
 
 License

health-sdk/README.md

@@ -35,7 +35,7 @@ clientSecret=*******
 In order to pass the Requirements a bank app needs to be installed on the device.
 
 An example bank app is available in the [Gini Bank SDK](https://github.com/gini/gini-mobile-android/tree/main/bank-sdk) called
-[`screen-api-example-app`](https://github.com/gini/gini-mobile-android/tree/main/bank-sdk/screen-api-example-app).
+[`example-app`](https://github.com/gini/gini-mobile-android/tree/main/bank-sdk/example-app).
 
 License
 -------