Update documentation for 1.0.1

Author: AbdullahDiaa

README.md

@@ -2,27 +2,33 @@
 
 A library for Dart developers. Help you manage notifications easily and effectively.
 
-## Usage
+## Example project
+
+You can try our sample project inlcuded with the library:
+```shell
+git clone [email protected]:pushbots/flutter-sdk.git
+cd flutter-sdk/example
+flutter run
+```
 
 
+## Usage
+
 Use this package as a library
 
-**1- Depend on it**
+**1- Add to dependencies:**
 
-Add this to your package's `pubspec.yaml` file:
+Add this to your package's `pubspec.yaml` file below dependencies:
 
 
-````
+````yaml
 dependencies:
   pushbots_flutter: ^1.0.1
 ````
 
-**2- Install it**
-
-You can install packages from the command line:
-
-with Flutter:
+**2- Install the SDK:**
 
+Run this command on your project:
 
 ````
 $ flutter pub get
@@ -31,23 +37,34 @@ $ flutter pub get
 Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.
 
 
+**3- Add to your project:**
 
+Now in your Dart code `lib/main.dart`, you can start using PushBots SDK:
 
-**3- Import it**
-
-Now in your Dart code, you can use:
-
-````
+````dart
 import 'package:pushbots_flutter/pushbots_flutter.dart';
 ````
 
+### iOS Setup
 
-### Android Setup
+#### Add PushBots service extension
 
-Add to `defaultConfig` section, then replace `PUSHBOTS_APP_ID` and `GOOGLE_SENDER_ID`
+Follow this article to add PushBots service extension in order to be able to use rich media in your iOS app, you'll find `Flutter SDK additional config` at the end of the article, please make sure to follow it:
 
+https://www.pushbots.help/en/articles/1571650-creating-notification-service-extension
 
-````
+#### Enable push notifications in your app
+
+1. Under targets, click on project name, then click on "+ Capability"
+2. Search for "Push notifications" and click on it, then search for "Background modes", click on it then enable "remote notifications" from the list
+
+![Enable push notifications](https://downloads.intercomcdn.com/i/o/243149291/bdb77b474f7d1c38ab65eca9/xcode8-2.gif)
+
+### Android Setup
+
+Add to `defaultConfig` section, then replace `PUSHBOTS_APPLICATION_ID` and `SENDER_ID`
+
+````gradle
 defaultConfig {
         // Add PushBots integration data
         manifestPlaceholders = [
@@ -60,27 +77,27 @@ defaultConfig {
 
 ````
 
-
-
-
 ### Flutter Usage
 
-
-Once added `pushbots_flutter` into your `pubspec.yaml`.
-
 #### Initializing PushBots:-
 
 
-You can start by initializing the `PushBotsFlutter` by calling **`PushbotsFlutter.initialize("PUSHBOTS_APPLICATIN_ID", "YOUR_WEBAPI_KEY", "YOUR_FCM_APP_ID", "YOUR_PROJECT_ID");`**
+You can start by initializing the `PushBotsFlutter` by calling 
+
+````dart
+PushbotsFlutter.initialize("PUSHBOTS_APPLICATIN_ID", "YOUR_WEBAPI_KEY", "YOUR_FCM_APP_ID", "YOUR_PROJECT_ID");
+````
 
+to be able to get all firebase cerdentials, check out this article for all details:
+https://www.pushbots.help/en/articles/498201-the-google-part-firebase-credentials
 
 ![Initialize Image](assets/fcm-info.png)
 
 
 Listen for notifiers (receive, open) notifications:-
 
 
-````
+````dart
  PushbotsFlutter.listenForNotificationReceive().stream.listen((onData) {
       print("MAIN, received: " + onData.toString());
     });
@@ -95,18 +112,18 @@ Update User info:-
 
 
 
-````
+````dart
 PushbotsFlutter.setName("Pushbotter");
 PushbotsFlutter.setFirstName("FirstName");
 PushbotsFlutter.setLastName("LastName");
 PushbotsFlutter.setEmail("[email protected]");
 PushbotsFlutter.setAlias("Alias");
 PushbotsFlutter.setPhone("phoneNumber");
-
-
 ````
+
 Other Methods: 
-````
+
+````dart
 PushbotsFlutter.debug(true);
 //Track event
 PushbotsFlutter.trackEvent("added_to_cart");
@@ -121,7 +138,7 @@ PushbotsFlutter.setTags(["tag1", "tag2"]);
 
 PushbotsFlutter.removeTags(["tag1"]);
 
-//  ---- iOS 
+//  ====== iOS only method ======
 //Set log level with alert
 //Log Levels :  noLog, error, warn, info, verbose
 PushbotsFlutter.setLogLevelWithUI(LogLevels.verbose.index,true);
@@ -133,15 +150,8 @@ PushbotsFlutter.setBadge(10);
 PushbotsFlutter.incrementBadgeCountBy(1);
 //Decrement badge count
 PushbotsFlutter.decrementBadgeCountBy(10);
-
-
 ````
 
-
-
-
-
-
 ## Feature and bugs
 
 Please fill issue on https://github.com/pushbots or https://stackoverflow.com/questions/tagged/pushbots