Merge branches 'develop' and 'feature/CONJ-249' of https://github.com…

…/MariaDB/mariadb-connector-j into feature/CONJ-249

README.md

@@ -49,12 +49,13 @@ Development snapshot are available on sonatype nexus repository
 ## Documentation
 
 For a Getting started guide, API docs, recipes,  etc. see the 
-* [About MariaDB connector/J](/documentation/About-MariaDB-Connector-J.md)
-* [Use MariaDB connector/j driver](/documentation/Use-MariaDB-Connector-j-driver.md)
-* [Failover and high-availability](/documentation/Failover-and-high-availability.md)
+* [About MariaDB connector/J](/documentation/about-mariadb-connector-j.creole)
+* [Use MariaDB connector/j driver](/documentation/use-mariadb-connector-j-driver.creole)
+* [Changelog](/documentation/changelog.creole)
+* [Failover and high-availability](/documentation/failover-and-high-availability-with-mariadb-connector-j.creole)
 
 
 ## Contributing
 To get started with a development installation and learn more about contributing, please follow the instructions at our 
-[Developers Guide.](/documentation/Developers-Guide.md)
+[Developers Guide.](/documentation/developers-guide.creole)
 

documentation/About-MariaDB-Connector-J.md → documentation/about-mariadb-connector-j.creole

@@ -1,66 +1,71 @@
-# About MariaDB java connector
+= About MariaDB java connector
 
 MariaDB Connector/J is used to connect applications developed in Java to
 MariaDB and MySQL databases using the standard JDBC API. The library is LGPL
 licensed.
 
 
-## Introduction
+== Introduction
 MariaDB Connector/J is a Type 4 JDBC driver.  It was developed specifically as
 a lightweight JDBC connector for use with MySQL and MariaDB database servers.
 It's originally based on the Drizzle JDBC code, and with a lot of additions and
 bug fixes.
 
-## Obtaining the driver
+== Obtaining the driver
 The driver source code can be downloaded from:
 https://downloads.mariadb.org/connector-java/
 
 Pre-built .jar files can be downloaded from:
 https://code.mariadb.com/connectors/java/
 
 
-## Installing the driver
+== Installing the driver
 Installation of the client library is very simple, the jar file should be saved
 in an appropriate place for your application and the classpath of your
 application altered to include MariaDB Connector/J rather than your current
 connector.
 
 Using maven : 
-```script
+{{{
 <dependency>
     <groupId>org.mariadb.jdbc</groupId>
     <artifactId>mariadb-java-client</artifactId>
     <version>xxx</version>
 </dependency>
-```
+}}}
 
-## Requirements
+== Requirements
 
-* Java 7 or 8 (Last compatible version with java 6 is [1.1.9](https://downloads.mariadb.org/connector-java/1.1.9/))
-* com.sun.JNA is used by some library functions and a jar is available at
-  https://github.com/twall/jna
-** only needed when connecting to the server with unix sockets or windows
-   shared memory
-* A MariaDB or MySQL Server 
-* maven (only if you want build from source)
+* Java 7 or 8 (Last compatible version with java 6 is [[https://downloads.mariadb.org/connector-java/1.1.9/|1.1.9]])
 
-## Source code
+Dependencies (not mandatory):
+* [[https://maven-badges.herokuapp.com/maven-central/com.github.dblock.waffle/waffle-jna|waffle-jna 1.8.1]]
+* [[https://maven-badges.herokuapp.com/maven-central/net.java.dev.jna/jna|jna 4.2.1]]
+* [[https://maven-badges.herokuapp.com/maven-central/net.java.dev.jna/jna-platform|jna-platform 4.2.1]]
+* [[https://maven-badges.herokuapp.com/maven-central/org.slf4j/jcl-over-slf4j|jcl-over-slf4j 1.7.14]]
+* [[https://maven-badges.herokuapp.com/maven-central/org.slf4j/slf4j-api|slf4j-api 1.7.14]]
+* [[https://maven-badges.herokuapp.com/com.google.guava/guava|guava 19.0]]
+
+jna is needed when when connecting to the server with unix sockets or windows shared memory
+All of them are needed for native windows kerberos implementation. (see  [[plugin/GSSAPI.creole|Gssapi documentation]])
+
+== Source code
 
 The source code is available on GitHub:
 https://github.com/MariaDB/mariadb-connector-j and the most recent development
 version can be obtained using the following command:
 
-```script
+{{{
 git clone https://github.com/MariaDB/mariadb-connector-j.git
-```
+}}}
 
-## License
+== License
 
 GNU Lesser General Public License as published by the Free Software Foundation;
 either version 2.1 of the License, or (at your option) any later version.
 
 
-## Building and testing the driver
+== Building and testing the driver
 
 The section deals with building the connector from source and testing it. If
 you have downloaded a ready built connector, in a jar file, then this section
@@ -74,15 +79,17 @@ To run the unit test, you'll need a MariaDB or MySQL server running on
 localhost (on default TCP port 3306) and a database called 'test', and user
 'root' with empty password
 
-```script
-git clone https://github.com/MariaDB/mariadb-connector-j.git #  Or, unpack the source distribution tarball
+{{{
+git clone https://github.com/MariaDB/mariadb-connector-j.git =  Or, unpack the source distribution tarball
 cd mariadb-connector-j
-# For the unit test run, start local mysqld mysqld, 
+
+# For the unit test run, start local mysqld mysqld,
 # ensure that user root with empty password can login
 mvn package
+
 # If you want to build without running unit  tests, use
 # mvn -Dmaven.test.skip=true package
-```
+}}}
 
 After that, you should have JDBC jar mariadb-java-client-x.y.z.jar in the
 'target' subdirectory