update of README

Author: bardram

README.md

@@ -3,18 +3,19 @@
 This repo contains the source code for Flutter first-party plugins maintained by the [Copenhagen Research Platform (CARP)](http://www.carp.dk/) team at the Technical University of Denmark.
 Check the `packages` directory for all plugins.
 
-Flutter plugins enable access to platform-specific APIs using a platform channel. 
+Flutter plugins enable access to platform-specific APIs using a platform channel.
 For more information about plugins and how to use them, see
 [https://flutter.io/platform-plugins/](https://flutter.io/platform-plugins/).
 
 ## Plugins
+
 These are the available plugins in this repository.
 
-| Plugin | Description | Android | iOS |    pub.dev    | 
+| Plugin | Description | Android | iOS |    pub.dev    |
 |--------|-------------|:-------:|:---:|:---------:|
 | [screen_state](./packages/screen_state) | Track screen state changes | ✔️ | ✔️ | [![pub package](https://img.shields.io/pub/v/screen_state.svg)](https://pub.dartlang.org/packages/screen_state) |
 | [light](./packages/light) | Track light sensor readings | ✔️ | ❌ |  [![pub package](https://img.shields.io/pub/v/light.svg)](https://pub.dartlang.org/packages/light) |
-| [pedometer](./packages/pedometer) | Track step count |  ✔️ | ✔️ | [![pub package](https://img.shields.io/pub/v/pedometer.svg)](https://pub.dartlang.org/packages/pedometer) |
+| [pedometer](./packages/pedometer) | Collect step events |  ✔️ | ✔️ | [![pub package](https://img.shields.io/pub/v/pedometer.svg)](https://pub.dartlang.org/packages/pedometer) |
 | [noise_meter](./packages/noise_meter) | Read noise level in Decibel | ✔️ | ✔️  | [![pub package](https://img.shields.io/pub/v/noise_meter.svg)](https://pub.dartlang.org/packages/noise_meter) |
 | [app_usage](./packages/app_usage) | Track usage of all applications on phone. | ✔️ | ❌  | [![pub package](https://img.shields.io/pub/v/app_usage.svg)](https://pub.dartlang.org/packages/app_usage) |
 | [weather](./packages/weather) | Get current weather, as well as forecasting using the OpenWeatherMap API. | ✔️ | ✔️  | [![pub package](https://img.shields.io/pub/v/weather.svg)](https://pub.dartlang.org/packages/weather) |
@@ -35,9 +36,7 @@ Please check existing issues and file any new issues, bugs, or feature requests
 
 ## Contributing
 
-As part of the open-source Flutter ecosystem, we would welcome any help in maintaining and enhancing these plugins. 
+As part of the open-source Flutter ecosystem, we would welcome any help in maintaining and enhancing these plugins.
 We (i.e., the CARP team) have limited resources for maintaining these plugins, and we rely on **your** help in this.
 We welcome any contribution - from small error corrections in the documentation, to bug fixes, to large feature enhancements, or even new features in a plugin.
 If you wish to contribute to any of the plugins in this repo, please review our [contribution guide](https://github.com/cph-cachet/flutter-plugins/CONTRIBUTING.md) and send a [pull request](https://github.com/cph-cachet/flutter-plugins/pulls).
-
-

packages/empatica_e4link/README.md

@@ -1,18 +1,15 @@
 # Empatica Flutter plugin
 
-Flutter plugin for the [Empatica E4](https://e4.empatica.com/e4-wristband)
-wristband on Android. iOS coming soon.
+Flutter plugin for the [Empatica E4](https://e4.empatica.com/e4-wristband) wristband on Android.
 
 ## Install (Flutter)
 
-Add `empatica_e4link` as a dependency in `pubspec.yaml` or run `flutter pub add
-empatica_e4link`
+Add `empatica_e4link` as a dependency in `pubspec.yaml` or run `flutter pub add empatica_e4link`
 For help on adding as a dependency, view the [pubspec documenation](https://flutter.io/using-packages/).
 
 ## Android
 
-The package uses your location and bluetooth to fetch data from the eSense ear plugs.
-Therefore location tracking and bluetooth must be enabled.
+The package uses bluetooth to fetch data from the E4 device. Therefore bluetooth usage must be declared. Since bluetooth also allow for locations tracking, location tracking permissions must also be declared.
 
 Add the following entry to your `manifest.xml` file, in the Android project of your application:
 
@@ -24,35 +21,25 @@ Add the following entry to your `manifest.xml` file, in the Android project of y
 <uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>
 ```
 
-Also make sure to obtain permissions in your app to use location and bluetooth.
-See the example app on how to e.g. use the [`permission_handler`](https://pub.dev/packages/permission_handler) for this. Note that the plugin **does not** handle permissions - this has to be done on an app level.
+Also make sure to obtain permissions in your app to use location and bluetooth. See the example app on how to e.g. use the [`permission_handler`](https://pub.dev/packages/permission_handler) for this. Note that the plugin **does not** handle permissions - this has to be done on an app level.
 
-Set the Android compile and minimum SDK versions to `compileSdkVersion 33`,
-and `minSdkVersion 28` respectively, inside the `android/app/build.gradle` file.
+Set the Android compile and minimum SDK versions to `compileSdkVersion 33`, and `minSdkVersion 28` respectively, inside the `android/app/build.gradle` file.
 
 ## iOS
 
 Due to compatibility issues with Empatica's SDK, the iOS implementation is not able to function with new CocoaPods and iPhone architectures.
 
 ## Usage
 
-The Empatica E4 Flutter plugin has been designed to resemble the Android
-Empatica API almost **1:1**. Hence, you should be able to recognize the names
-of the different classes and class variables.
-For example, the methods on the `EmpaticaDeviceManager` class is mapped 1:1.
-See the [Empatica Android documentation](https://developer.empatica.com/empatica-android-sdk-javadoc.zip) on how it all works.
+The Empatica E4 Flutter plugin has been designed to resemble the Android Empatica API almost **1:1**. Hence, you should be able to recognize the names of the different classes and class variables. For example, the methods on the `EmpaticaDeviceManager` class is mapped 1:1. See the [Empatica Android documentation](https://developer.empatica.com/empatica-android-sdk-javadoc.zip) on how it all works.
 
-However, one major design change has been done; this Empatica Flutter plugin complies to the Dart/Flutter reactive programming architecture using [Stream](https://api.dart.dev/dart-async/Stream-class.html)s.
-Hence, you do not get callbacks to an Empatica device (as you do in Java) -- rather, you obtain a Dart stream and listen to this stream (and exploit all the [other very nice stream operations](https://dart.dev/tutorials/language/streams) which are available in Dart).
-Below, we shall describe how to use the Empatica streams.
-But first -- let's see how to set up and connect to an Empatica E4 device in the first place.
+However, one major design change has been done; this Empatica Flutter plugin complies to the Dart/Flutter reactive programming architecture using [Stream](https://api.dart.dev/dart-async/Stream-class.html)s. Hence, you do not get callbacks to an Empatica device (as you do in Java) -- rather, you obtain a Dart stream and listen to this stream (and exploit all the [other very nice stream operations](https://dart.dev/tutorials/language/streams) which are available in Dart). Below, we shall describe how to use the Empatica streams. But first -- let's see how to set up and connect to an Empatica E4 device in the first place.
 
 ### Setting up and Connecting to an Empatica Device
 
 All operations on the Empatica device happens via the `Empatica plugin`
 
-At first one must connect to the Empatica backend via an API key given by
-Empatica using the `authenticateWithAPIKey` method.
+At first one must connect to the Empatica backend via an API key given by Empatica using the `authenticateWithAPIKey` method.
 
 ```dart
 import 'package:empatica_e4link/empatica.dart';
@@ -85,18 +72,13 @@ await deviceManager.startScanning();
 
 ```
 
-Everything with the Empatica API happens asynchronously. Hence, the `connectDevice` call merely initiates the connection
-process. In order to know the status of the device manager, you should listen to
-status events `statusEventSink`.
+Everything with the Empatica API happens asynchronously. Hence, the `connectDevice` call merely initiates the connection process. In order to know the status of the device manager, you should listen to status events `statusEventSink`.
 This is done via the `statusEventSink` stream.
-Note, that if you want to know if your connection to the device is successful, you should initiate listening
-**before** the connection is initiated, as shown above.
+Note, that if you want to know if your connection to the device is successful, you should initiate listening **before** the connection is initiated, as shown above.
 
 ### Listen to physiological data
 
-When the status is `CONNECTED` the device will be sending all data events to
-`dataEventSink`. To get _ALL_ data one should start listening on this stream
-before it is connected, e.g. when the status is `CONNECTING`.
+When the status is `CONNECTED` the device will be sending all data events to `dataEventSink`. To get _ALL_ data one should start listening on this stream before it is connected, e.g. when the status is `CONNECTING`.
 
 ```dart
 deviceManager.dataEventSink?.listen((event) {
@@ -120,7 +102,4 @@ The possible data events in the `dataEventSink` are:
 
 ## Contributing
 
-### Android
-
-The Gradle task useAar in ./android has to be run for the Empatica SDK to be
-modeled and used in the Android code.
+The Gradle task useAar in `./android` has to be run for the Empatica SDK to be modeled and used in the Android code.