From f08cfbc963b3ebde801b4190db83046cc4b9a13f Mon Sep 17 00:00:00 2001
From: Prerak Mann <mannprerak2@gmail.com>
Date: Tue, 6 Aug 2019 20:53:37 +0530
Subject: [PATCH] update readme

---
 README.md                   | 34 ++++++++++++++++++++++++----------
 lib/nearby_connections.dart |  9 +++++++--
 2 files changed, 31 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 172911a..fbeb683 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,20 @@
 # nearby_connections
 
-An android flutter plugin for the Nearby Connections API
+An **android** flutter plugin for the Nearby Connections API
 
 [![pub package](https://img.shields.io/pub/v/nearby_connections.svg)](https://pub.dartlang.org/packages/nearby_connections)
 
-## Getting Started
+## Table of Content
+* [Setup](#setup)
+* [Work Flow](#Work%20Flow)
+    * [Advertise For connections](#Advertise%20for%20connection)
+    * [Discover Advertisers](#Discover%20Advertisers)
+    * [Request Connection](#Request%20Connection)
+    * [Accept Connection](#Accept%20Connection)
+* [Sending Data](#Sending%20Data)
+    * [Senging Bytes Payload](#Sending%20Bytes%20Payload)
+
+## Setup
 
 ### Set Permissions
 Add these to AndroidManifest.xml
@@ -28,11 +38,11 @@ bool a = await Nearby().checkPermissions()
 Nearby().askPermission()
 ```
 
-### Working Flow
+## Work Flow
 
-The working flow is similar to the [android nearby connections library](https://developers.google.com/nearby/connections/overviewoverview)
+The work flow is similar to the [android nearby connections library](https://developers.google.com/nearby/connections/overviewoverview)
 
-#### Advertise for connection
+### Advertise for connection
 ```dart
 try {
     bool a = await Nearby().startAdvertising(
@@ -52,7 +62,7 @@ try {
     // platform exceptions like unable to start bluetooth or insufficient permissions 
 }
 ```
-#### Discover Advertisers
+### Discover Advertisers
 ```dart
 try {
     bool a = await Nearby().startDiscovery(
@@ -69,11 +79,14 @@ try {
     // platform exceptions like unable to start bluetooth or insufficient permissions
 }
 ```
-#### Start and Stop Discovery
+### Stopping Advertising and Discovery
 ```dart
 Nearby().stopAdvertising();
 Nearby().stopDiscovery();
-
+// endpoints already discovered will still be available to connect
+// even after stopping discovery
+// You should stop discovery once you have found the intended advertiser
+// this will reduce chances for disconnection
 ```
 ### Request Connection
 ```dart
@@ -94,7 +107,7 @@ try{
     // called if request was invalid
 }
 ```
-#### Accept Connections
+### Accept Connection
 ```dart
 Nearby().acceptConnection(
     id,
@@ -103,7 +116,8 @@ Nearby().acceptConnection(
     },
 );
 ```
-### Sending Payload
+## Sending Data
+### Sending Bytes Payload
 
 ```dart
 Nearby().sendPayload(endpointId, bytes_array);
diff --git a/lib/nearby_connections.dart b/lib/nearby_connections.dart
index 565d8b4..12a0548 100644
--- a/lib/nearby_connections.dart
+++ b/lib/nearby_connections.dart
@@ -4,6 +4,11 @@ import 'dart:typed_data';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
 
+/// **P2P_CLUSTER** - best for small payloads and multiplayer games
+/// 
+/// **P2P_STAR** - best for medium payloads, higher bandwidth than cluster
+/// 
+/// **P2P_POINT_TO_POINT** - single connection, very high bandwidth
 enum Strategy { P2P_CLUSTER, P2P_STAR, P2P_POINT_TO_POINT }
 enum Status { CONNECTED, REJECTED, ERROR }
 
@@ -17,7 +22,7 @@ typedef void OnEndpointFound(
 typedef void OnEndpointLost(String endpointId);
 
 typedef void OnPayloadReceived(String endpointId, Uint8List bytes);
-
+// typedef void OnPayloadTransferUpdate();
 /// The NearbyConnection class
 ///
 /// Only one instance is maintained
@@ -330,7 +335,7 @@ class Nearby {
 ///
 /// [endPointName] is userNickName of requester
 ///
-/// [authenticationToken] is useful to check the connection security
+/// [authenticationToken] can be used to check the connection security
 /// it must be same on both devices
 class ConnectionInfo {
   String endpointName, authenticationToken;