Update README

Author: joextodd

chirpsdk/LICENSE

@@ -1,6 +1,6 @@
 # Chirp License.
 
-This software is copyright © 2011-2018, Asio Ltd. All rights reserved.
+This software is copyright © 2011-2019, Asio Ltd. All rights reserved.
 
 This software is provided under license from Asio Ltd. It is to be used only in accordance with our Fair Use Policy, available at
 

chirpsdk/README.md

@@ -9,6 +9,41 @@ Sign up at the Chirp [Developer Hub](https://developers.chirp.io/sign-up)
 Copy and paste your Chirp app key, secret and chosen configuration into the
 [example application](https://github.com/chirp/chirp-connect-flutter/tree/master/chirpsdk/example)
 
+## Configuration
+
+It is recommended to use the example code as a template, but in short, configuring the
+SDK is as simple as initialising with your credentials and chosen configuration, and starting
+the audio processing.
+
+    await ChirpSDK.init(_appKey, _appSecret);
+    await ChirpSDK.setConfig(_appConfig);
+    await ChirpSDK.start();
+
+## Sending
+
+Chirp SDKs accept data as an array of bytes, creating a versatile interface for all kinds of data.
+However in most cases, Chirp is used to send a short identifier. Here is an example of how to send
+a short string with the Chirp SDK.
+
+    String identifier = "hello";
+    var payload = new Uint8List.fromList(identifier.codeUnits);
+    await ChirpSDK.send(payload);
+
+It is worth noting here that the send method will not block until the entire payload has been sent,
+but just as long as it takes to pass the message to the SDK. Please use the onSent callback for this
+purpose.
+
+## Receiving
+
+To receive data you can listen for received events like so
+
+    ChirpSDK.onReceived.listen((e) {
+        String identifier = new String.fromCharCodes(e.payload);
+    });
+
+A received event includes the `payload` and the `channel` for multichannel configurations.
+There are several other callbacks available which are illustrated in the example.
+
 ## Contributions
 
 This project aims to be a community driven project and is open to contributions.

chirpsdk/android/src/main/kotlin/io/chirp/chirpsdk/ChirpsdkPlugin.kt

@@ -51,7 +51,7 @@ class ChirpsdkPlugin(val activity: Activity) : MethodCallHandler {
 
   override fun onMethodCall(call: MethodCall, result: Result) {
 
-    if (call.method == "initialise") {
+    if (call.method == "init") {
       val arguments = call.arguments as java.util.HashMap<String, String>
       val appKey = arguments["key"] as String
       val appSecret = arguments["secret"] as String

chirpsdk/example/README.md

@@ -1,16 +1,9 @@
-# chirpsdk_example
+# ChirpSDK Example
 
-Demonstrates how to use the chirpsdk plugin.
+Demonstrates how to use the ChirpSDK plugin.
 
 ## Getting Started
 
-This project is a starting point for a Flutter application.
+This project is a starting point for a Flutter application using Chirp.
 
-A few resources to get you started if this is your first Flutter project:
-
-- [Lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook)
-
-For help getting started with Flutter, view our 
-[online documentation](https://flutter.io/docs), which offers tutorials, 
-samples, guidance on mobile development, and a full API reference.
+- [Example Code](https://github.com/chirp/chirp-connect-flutter/tree/master/chirpsdk/example)

chirpsdk/example/lib/main.dart

@@ -26,8 +26,8 @@ class _ChirpAppState extends State<ChirpApp> with WidgetsBindingObserver {
   String _chirpVersion = 'Unknown';
   Uint8List _chirpData = Uint8List(0);
 
-  Future<void> _initialiseChirp() async {
-    await ChirpSDK.initialise(_appKey, _appSecret);
+  Future<void> _initChirp() async {
+    await ChirpSDK.init(_appKey, _appSecret);
   }
 
   Future<void> _configureChirp() async {
@@ -92,7 +92,7 @@ class _ChirpAppState extends State<ChirpApp> with WidgetsBindingObserver {
   void initState() {
     super.initState();
     _requestPermissions();
-    _initialiseChirp();
+    _initChirp();
     _configureChirp();
     _getChirpVersion();
     _setChirpCallbacks();

chirpsdk/ios/Classes/ChirpsdkPlugin.m

@@ -49,7 +49,7 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
 }
 
 - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
-  if ([@"initialise" isEqualToString:call.method]) {
+  if ([@"init" isEqualToString:call.method]) {
     NSString *key = call.arguments[@"key"];
     NSString *secret = call.arguments[@"secret"];
     self.connect = [[ChirpConnect alloc] initWithAppKey:key

chirpsdk/lib/chirpsdk.dart

@@ -19,7 +19,6 @@ class ChirpSDK {
   static const EventChannel _sentEvents = const EventChannel('chirp.io/events/sent');
   static const EventChannel _receivingEvents = const EventChannel('chirp.io/events/receiving');
   static const EventChannel _receivedEvents = const EventChannel('chirp.io/events/received');
-  static const EventChannel _volumeEvents = const EventChannel('chirp.io/events/volume');
   static const EventChannel _errorEvents = const EventChannel('chirp.io/events/errors');
 
   /// Initialise the ChirpSDK
@@ -28,9 +27,9 @@ class ChirpSDK {
   /// up for Chirp at the Developer Hub[1].
   ///
   /// [1]: https://developers.chirp.io
-  static Future<void> initialise(String key, String secret) async {
+  static Future<void> init(String key, String secret) async {
     var parameters = { 'key': key, 'secret': secret };
-    await _methods.invokeMethod('initialise', new Map.from(parameters));
+    await _methods.invokeMethod('init', new Map.from(parameters));
   }
 
   /// Get the Chirp SDK version info as a string
@@ -84,7 +83,7 @@ class ChirpSDK {
     await _methods.invokeMethod('sendRandom');
   }
 
-  /// Check if payload is valid for the current configuration
+  // Check if payload is valid for the current configuration
   // static Future<bool> isValidPayload(Uint8List payload) async {
   //   final bool valid = await _methods.invokeMethod('isValidPayload', payload);
   //   return valid;