Update readme

README.md

@@ -1,2 +1,201 @@
 # easydatabinding
 This project goal is to create activity fragment and views, with less code to be more efficient on the view models
+
+
+# Goal
+
+I used DataBinding for a few weeks since Google allows us to use it.
+
+For now i saw a lot of duplicated code to instantiate an activity or a fragment
+
+## DataBinding
+
+- Each Activity or Fragmentis linked to a viewmodel who will expose the data to the view (layout) and handle some specific fucntionnalities
+
+
+- ViewModel will also handle some treatments :
+
+    - WS Calls / Database to update the recyclerview of the layout
+    - activityresult of activity (for facebook / google login for example)
+
+So in a very general case, code of an activity will look like this :
+
+### Activity
+
+For example, in class DB, we have to do
+
+-  layout
+-  class activity
+-  class view model linked to the activity
+
+
+
+#### Layout
+
+First of all we need something like this for the layout
+
+```
+<?xml version="1.0" encoding="utf-8"?>
+
+<layout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <data>
+
+
+        <variable
+            name="activityXXXViewModel"
+            type="package.to.your.viewmodel.ActivityXXXViewModel" />
+    </data>
+
+    <android.support.design.widget.CoordinatorLayout
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:fitsSystemWindows="true"
+        tools:bindingContext=".core.MainActivity">
+
+        <android.support.design.widget.AppBarLayout
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:theme="@style/AppTheme.AppBarOverlay">
+
+            <android.support.v7.widget.Toolbar
+                android:id="@+id/toolbar"
+                android:layout_width="match_parent"
+                android:layout_height="?attr/actionBarSize"
+                android:background="?attr/colorPrimary"
+                app:popupTheme="@style/AppTheme.PopupOverlay" />
+
+        </android.support.design.widget.AppBarLayout>
+
+
+        <RelativeLayout
+            android:layout_width="match_parent"
+            android:layout_height="match_parent"
+            app:layout_behavior="@string/appbar_scrolling_view_behavior">
+
+
+
+        </RelativeLayout>
+
+
+    </android.support.design.widget.CoordinatorLayout>
+</layout>
+
+```
+
+Then Comes our view model :
+
+### ViewModel : XXXActivityViewModel
+
+```
+
+/**
+ * Created by josh on 11/03/16.
+ */
+public class ActivityXXXViewModel extends BaseObservable implements ViewModel {
+    private static final String TAG = ActivityXViewModel.class.getSimpleName();
+
+
+    private final Context context;
+    private final ActivityXXXBinding binding;
+    /***
+     * @param context
+     */
+    public ActivityXXXViewModel(ActivityXXX context, ActivityXXXBinding binding) {
+        this.context = context;
+        this.binding = binding;
+    }
+
+    @Override
+    public void onDestroy() {
+
+    }
+
+}
+
+```
+
+
+### Activity : XXXActivity
+
+ELle va juste servir de "pont" pour créer le Binding avec le view model.
+
+
+```
+/***
+Activity exemple pour du databinding contenant une recyclerview
+***/
+public class XXXActivity extends AppCompatActivity {
+
+    /***
+     * Cette classe est générée par le DataBinding en prenant le nom du layout {@link com.phoceis.kioskcultura_mobile.R.layout#activity_stores}
+     * et en ajoutant Binding à la fin
+     */
+    ActivityXXXBinding binding;
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        binding = DataBindingUtil.setContentView(this, R.layout.activity_xxx);
+        setSupportActionBar(binding.toolbar);
+        ActivityXXXViewModel activityXXXViewModel = new ActivityXXXViewModel(this);
+        binding.setActivityXXXViewModel(activityXXXViewModel);
+        binding.xxxRecyclerView.setLayoutManager(new LinearLayoutManager(this));
+    }
+
+}
+
+```
+
+
+
+With the library an activity will be :
+
+
+```
+public class ActivityBaseMain extends ActivityBase<ActivityMainBinding,ActivityMainBaseVM> {
+
+    @Override
+    public int data() {
+        return joxad.easydatabinding.sample.BR.mainActivityVM;
+    }
+
+    @Override
+    public int layoutResources() {
+        return R.layout.activity_main;
+    }
+
+    @Override
+    public ActivityMainBaseVM baseActivityVM(ActivityMainBinding binding) {
+        return new ActivityMainBaseVM(this, binding);
+    }
+
+}
+```
+
+And your VM :
+
+```
+public class ActivityMainBaseVM extends ActivityBaseVM<ActivityBaseMain, ActivityMainBinding> {
+    /***
+     * @param activity
+     * @param binding
+     */
+    public ActivityMainBaseVM(ActivityBaseMain activity, ActivityMainBinding binding) {
+        super(activity, binding);
+    }
+
+    @Override
+    public void init() {
+
+    }
+
+    @Override
+    public void destroy() {
+
+    }
+}
+```
+