Update README.md

Author: kbiakov

README.md

@@ -8,26 +8,26 @@ CodeView helps to show code content with syntax highlighting in native way.
 ## Description
 CodeView contains 3 core parts to implement necessary logic:<br>
 
-1. <b>CodeClassifier</b> is trying to define what language presented in code snippet. It built upon <a href="https://github.com/ptnplanet/Java-Naive-Bayes-Classifier">Naive Bayes classifier</a>. There is no need to work with this class directly & you must just follow instructions below. (Experimental module, may not work properly!)<br>
+1. <b>CodeClassifier</b> is trying to define what language presented in code snippet. It built upon [Naive Bayes classifier](https://github.com/ptnplanet/Java-Naive-Bayes-Classifier). There is no need to work with this class directly & you must just follow instructions below. (Experimental module, may not work properly!)<br>
 
-2. For highlighting it uses <b>CodeHighlighter</b>, just highlights your code & returns formatted content. It based on Google Prettify and <a href="https://github.com/twalcari/java-prettify">their fork</a>.<br>
+2. For highlighting it uses <b>CodeHighlighter</b>, just highlights your code & returns formatted content. It based on [Google Prettify](https://github.com/google/code-prettify) and their Java implementation & [fork](https://github.com/google/code-prettify).<br>
 
-3. <b>CodeView</b> & related adapter.<br>
+3. <b>CodeView</b> & related abstract adapter to provide customization (see below).<br>
 
 ## Download
 Add it in your root ```build.gradle``` at the end of repositories:
 ```groovy
 allprojects {
-	repositories {
-		...
-		maven { url "https://jitpack.io" }
-	}
+    repositories {
+        ...
+        maven { url "https://jitpack.io" }
+    }
 }
 ```
 
 Add the dependency:
 ```groovy
-compile 'com.github.softwee:codeview-android:1.1.0'
+compile 'com.github.softwee:codeview-android:1.1.1'
 ```
 
 ## Usage
@@ -40,9 +40,9 @@ CodeProcessor.init(this);
 Add view for your layout:
 ```xml
 <io.github.kbiakov.codeview.CodeView
-        android:id="@+id/code_view"
-        android:layout_width="wrap_content"
-        android:layout_height="wrap_content"/>
+	android:id="@+id/code_view"
+	android:layout_width="wrap_content"
+	android:layout_height="wrap_content"/>
 ```
 
 Use chaining syntax when build view:
@@ -72,25 +72,81 @@ or eplixit (see available extensions below):
 codeView.highlightCode("js"); // it will work fast!
 ```
 
-Extend default color theme or create your own (don't forget to open PR with this stuff!):
+Extend default color theme:
 ```java
 int myColor = ContextCompat.getColor(this, R.color.code_content_background);
 codeView.setColorTheme(ColorTheme.SOLARIZED_LIGHT.withBgContent(myColor));
 ```
+or provide your own (don't forget to open PR with this stuff!)
 ```java
-codeView.setColorTheme(new ColorThemeData(new SyntaxColors(...)));
+codeView.setColorTheme(new ColorThemeData(new SyntaxColors(...), ...));
 ```
 
 Handle user clicks on code lines:
 ```java
 codeView.setCodeListener(new OnCodeLineClickListener() {
     @Override
-    public void onCodeLineClicked(int n) {
-      // your logic here
+    public void onCodeLineClicked(int n, @NotNull String line) {
+        Log.i("ListingsActivity", "On " + (n + 1) + " line clicked");
     }
 });
 ```
 
+Enable shadows to hide scrolled content:
+```java
+codeView.setShadowsEnabled(true);
+```
+
+## Adapter customization
+Sometimes you may want to add some content under line. You can create your own implementation as follows:
+
+1. Create your model to store data, for example some ```MyModel``` class.<br>
+2. Extend ```AbstractCodeAdapter<MyModel>``` typed by your model class.<br>
+3. Implement necessary methods in obtained ```MyCodeAdapter<MyModel>```:
+```kotlin
+// Kotlin
+class MyCodeAdapter : AbstractCodeAdapter<MyModel> {
+    constructor(context: Context, content: String) : super(context, content)
+
+    override fun createFooter(context: Context, entity: MyModel, isFirst: Boolean) =
+        /* init & return your view here */
+}
+```
+```java
+// Java
+public class MyCodeAdapter extends AbstractCodeAdapter<MyModel> {
+    public CustomAdapter(@NotNull Context context, @NotNull String content) {
+    	// @see params in AbstractCodeAdapter
+        super(context, content, true, 10, context.getString(R.string.show_all), null);
+    }
+
+    @NotNull
+    @Override
+    public View createFooter(@NotNull Context context, CustomModel entity, boolean isFirst) {
+        return /* init your view here */;
+    }
+}
+```
+<br>
+4. Set custom adapter to your code view:
+```java
+final CodeWithDiffsAdapter diffsAdapter = new CodeWithDiffsAdapter(this, getString(R.string.listing_py));
+codeView.setAdapter(diffsAdapter);
+```
+<br>
+5. Init footer entities to provide mapper from your view to model:
+```java
+// it will add an addition diff to code line
+diffsAdapter.addFooterEntity(16, new DiffModel(getString(R.string.py_addition_16), true));
+// and this a deletion diff
+diffsAdapter.addFooterEntity(11, new DiffModel(getString(R.string.py_deletion_11), false));
+```
+<br>
+6. You can also add a multiple diff entities, see ```AbstractCodeAdapter<MyModel>.addFooterEntities(HashMap<Int, List<MyModel>>)``` method). Here you must provide a map from code line numbers (started from 0) to list of line entities. It will be mapped by adapter to specified footer views.
+<br>
+
+See [Github diff](https://github.com/Softwee/codeview-android/blob/master/codeview/src/main/java/io/github/kbiakov/codeview/adapters/CodeWithDiffsAdapter.kt) as example of my "best practice" implementation.
+
 ## How it looks in app
 See <a href="https://github.com/Softwee/codeview-android/blob/master/example/src/main/java/io/github/kbiakov/codeviewexample/ListingsActivity.java">example</a>.<br>
 
@@ -101,8 +157,18 @@ C/C++/Objective-C (```"c"```, ```"cc"```, ```"cpp"```, ```"cxx"```, ```"cyc"```,
 
 Didn't found yours? Please, open issue to show your interest & I try to add this language in next releases.
 
+## List of available themes
+1. Default (simple light theme)
+2. Solarized Light
+3. Monokai
+
+## Contribute
+1. You can add your theme (see [ColorTheme](https://github.com/Softwee/codeview-android/blob/master/codeview/src/main/java/io/github/kbiakov/codeview/highlight/CodeHighlighter.kt) class). Try to add some classic color themes or create your own if it looks cool. You can find many of them in different open-source text editors.<br>
+2. If you are strong in a regex add missed language as shown [here](https://github.com/Softwee/codeview-android/blob/master/codeview/src/main/java/io/github/kbiakov/codeview/highlight/prettify/lang/LangScala.java). You can find existing regex for some language in different sources of js-libraries, etc, which plays the same role.<br>
+3. Various adapters also welcome, many use cases are impossible to cover.
+
 ## Author
-### <a href="https://github.com/kbiakov">Kirill Biakov</a>
+### [Kirill Biakov](https://github.com/kbiakov)
 
 ## License MIT
 Copyright (c) 2016 Softwee