From 0c0e601e42ee0800f91d390975a19351106947ff Mon Sep 17 00:00:00 2001
From: Kirill Biakov <kbiakov@gmail.com>
Date: Tue, 23 Aug 2016 15:52:59 +0300
Subject: [PATCH] Update README.md

---
 README.md | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)

diff --git a/README.md b/README.md
index fb7526a..040e256 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,105 @@
 # CodeView (Android)
 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.<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>
+3. <b>CodeView</b> & necessary adapter.<br>
+
+## Download
+Add it in your root ```build.gradle``` at the end of repositories:
+```groovy
+allprojects {
+	repositories {
+		...
+		maven { url "https://jitpack.io" }
+	}
+}
+```
+
+Add the dependency:
+```groovy
+compile 'com.github.softwee:codeview-android:1.0.0'
+```
+
+## Usage
+If you want to use code classifier to auto language recognizing just add to your ```Application.java```:
+```java
+// train classifier on app start
+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"/>
+```
+
+Use chaining syntax when build view:
+```java
+CodeView codeView = (CodeView) findViewById(R.id.code_view);
+
+codeView.highlightCode("js")
+        .setColorTheme(ColorTheme.SOLARIZED_LIGHT.withBgContent(myColor))
+        .setCodeContent(getString(R.string.listing_js));
+```
+
+And perform actions sequentially when view built:
+```java
+codeView.setCodeContent(getString(R.string.listing_java));
+codeView.highlightCode("java");
+```
+
+You can use both forms for build & built view, but note: ```setCodeContent(String)``` is final step when you build your view, otherwise not. If you firstly highlight and then set code content, code will not be highlighted. Instructions above helps you to avoid errors. View has state to handle this behavior.
+
+## Customizing
+1. Use implicit or eplixit form to code highlighting:
+```java
+codeView.highlightCode();
+```
+```java
+codeView.highlightCode("js"); // it will work fast!
+```
+
+2. Extend default color theme or create your own (don't forget to open PR with this stuff!):
+```java
+int myColor = ContextCompat.getColor(this, R.color.code_content_background);
+codeView.setColorTheme(ColorTheme.SOLARIZED_LIGHT.withBgContent(myColor));
+```
+```java
+codeView.setColorTheme(new ColorThemeData(new SyntaxColors(...)));
+```
+
+3. Handle user clicks on code lines:
+```java
+codeView.setCodeListener(new OnCodeLineClickListener() {
+    @Override
+    public void onCodeLineClicked(int n) {
+      // your logic here
+    }
+});
+```
+
+## License MIT
+Copyright (c) 2016 Softwee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.