Merge pull request #10 from ibrahimyilmaz/feature/change_readme_for_n…

…onnull_observe

Feature/change readme for nonnull observe

CHANGELOG.MD

@@ -1,9 +1,11 @@
 # Changelog
 
-## [Unreleased]
+## [Development]
+- ChangeLog updated for Non Null Observe.
 
 ## Bursa(0.0.2)
 - Non Null Observe extension method is added.
+
 ## Bursa(0.0.1)
 - Bintray Publish
 - PublishLiveData and ReplayLiveData implemented

README.MD

@@ -2,7 +2,7 @@
 ArchData
 =======
 
-ArchData provides two missing LiveData of Android Lifecycle Component.
+ArchData provides two missing LiveData of Android Lifecycle Component and useful extension functions.
 
 `MutableLiveData` shares only last state to its new observers when they start to observe.
 
@@ -15,6 +15,10 @@ Basically:
 * `PublishLiveData` is `MutableLiveData`, which only notify its observers if there is an event after their starting of observation.
 * `ReplayLiveData` is `MutableLiveData`, which only notify its observers for all previous events happened before their observation starts.
 
+Extension Functions:
+
+* `nonNullObserve` is extension function, which eliminates nullable invokes of Observer.
+
 
 Usage
 -----
@@ -27,27 +31,46 @@ Usage
     ```kotlin
     val liveData = PublishLiveData<String>();
     // observer1 will receive all events
-    liveData.observe(lifeCycleOwner,observer1);
-    liveData.postValue("one");
-    liveData.postValue("two");
+    liveData.observe(lifeCycleOwner,observer1)
+    liveData.postValue("one")
+    liveData.postValue("two")
     // observer2 will only receive "three"
-    liveData.observe(lifeCycleOwner,observer2);
-    liveData.postValue("three");
+    liveData.observe(lifeCycleOwner,observer2)
+    liveData.postValue("three")
     ```
 
  *  **`ReplayLiveData`**
 
     LiveData that buffers all items it observes and replays them to any `Observer` that subscribes.
 
     ```kotlin
-    val liveData =  ReplayLiveData<String>();
-    liveData.postValue("one");
-    liveData.postValue("two");
-    liveData.postValue("three");
+    val liveData =  ReplayLiveData<String>()
+    liveData.postValue("one")
+    liveData.postValue("two")
+    liveData.postValue("three")
     // both of the following will get the events from above
-    liveData.observe(lifeCycleOwner,observer1);
-    liveData.postValue(lifeCycleOwner,observer2);
+    liveData.observe(lifeCycleOwner,observer1)
+    liveData.postValue(lifeCycleOwner,observer2)
     ```
+
+    *  **`nonNullObserve`**
+
+        LiveData that buffers all items it observes and replays them to any `Observer` that subscribes.
+
+        ```kotlin
+
+        val liveData = MutableLiveData<String>()
+        ...
+
+        viewModel.liveData.nonNullObserve(lifeCycleOwner,::onLiveDataEvent)
+
+        ...
+
+        fun onLiveDataEvent(event: String){
+           //Do something good!.
+        }
+
+        ```
 
 Download
 --------