Updated documentation

Author: puneetbehl

README.asciidoc

@@ -22,7 +22,7 @@ Edit your project's +build.gradle+ file, by adding the plugin's dependency decla
 ----
 dependencies {
     ...
-    compile "org.grails.plugins:elasticsearch:1.2.1"
+    compile "org.grails.plugins:elasticsearch:2.4.0"
     ...
 
 }
@@ -34,6 +34,15 @@ dependencies {
 |===
 |Plugin Version | Grails Version | Elasticsearch Version
 
+|2.4.0
+|3.1.y
+|5.4.1
+
+|1.4.1
+|3.1.y
+|5.4.1
+
+
 |1.2.1
 |3.2.y
 |2.3.z

src/docs/introduction/versioning.adoc

@@ -11,7 +11,8 @@ If necessary a 4th level point release number will be used for successive change
 
 |===
 s| Plugin Version    s| Grails                s| Elasticsearch
-s| 1.4.1           s| 3.1.x                 s| 5.x (tested with 5.4.1)
+s| 2.4.0             s| 3.3.x                 s| 5.x
+s| 1.4.1             s| 3.1.x                 s| 5.x (tested with 5.4.1)
 s| 1.2.0             s| 3.1.x                 s| 2.3.x
 s| 1.0.0.2           s| 3.1.x                 s| 1.x
 s| 0.1.0             s| 2.4.x                 s| 2.1.x

src/docs/mapping/quickStart.adoc

@@ -1,5 +1,73 @@
 === Quick Start
 
+* Install Elasticsearch using instructions from https://www.elastic.co/guide/en/elasticsearch/reference/5.4/gs-installation.html[here].
+
+* Just like any other Grails plugin, through the Grails Plugin center and Edit your project's +build.gradle+ file, by adding the plugin's dependency declaration:
+
+----
+dependencies {
+    ...
+    compile "org.grails.plugins:elasticsearch:2.4.0"
+    ...
+}
+----
+
+* Updated `application.yml` with default configurations:
+----
+elasticSearch:
+    datastoreImpl: hibernateDatastore
+    client:
+        mode: transport
+        hosts:
+          - {host: localhost, port: 9300}
+    cluster.name: <ENTER CLUSTER NAME HERE>
+----
+
+In order debug Elasticsearch plugin, add `logger("grails.plugins.elasticsearch", DEBUG, ['STDOUT'], false)` in `logback.groovy file as following:
+
+----
+import grails.util.BuildSettings
+import grails.util.Environment
+import org.springframework.boot.logging.logback.ColorConverter
+import org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter
+
+import java.nio.charset.Charset
+
+conversionRule 'clr', ColorConverter
+conversionRule 'wex', WhitespaceThrowableProxyConverter
+
+// See http://logback.qos.ch/manual/groovy.html for details on configuration
+appender('STDOUT', ConsoleAppender) {
+    encoder(PatternLayoutEncoder) {
+        charset = Charset.forName('UTF-8')
+
+        pattern =
+                '%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} ' + // Date
+                        '%clr(%5p) ' + // Log level
+                        '%clr(---){faint} %clr([%15.15t]){faint} ' + // Thread
+                        '%clr(%-40.40logger{39}){cyan} %clr(:){faint} ' + // Logger
+                        '%m%n%wex' // Message
+    }
+}
+
+def targetDir = BuildSettings.TARGET_DIR
+if (Environment.isDevelopmentMode() && targetDir != null) {
+    appender("FULL_STACKTRACE", FileAppender) {
+        file = "${targetDir}/stacktrace.log"
+        append = true
+        encoder(PatternLayoutEncoder) {
+            pattern = "%level %logger - %msg%n"
+        }
+    }
+    logger("StackTrace", ERROR, ['FULL_STACKTRACE'], false)
+    logger("grails.plugins.elasticsearch", DEBUG, ['STDOUT'], false)
+    root(ERROR, ['STDOUT', 'FULL_STACKTRACE'])
+}
+else {
+    root(ERROR, ['STDOUT'])
+}
+----
+
 ==== Default mapping
 
 To declare a domain class to be searchable, the simplest way is to define the following static property in the code: