Add gradle build documents (#59)

Author: birdstorm

README.md

@@ -9,28 +9,59 @@ It is supposed to:
 
 ## How to build
 
+### Gradle
+
+Alternatively, you can build `tikv-client-java` with gradle.
+
+The following command will build the project.
+
+```
+gradle init
+gradle clean build -x test
+```
+
+To make a jar with dependencies
+
+```
+gradle clean fatJar -x test
+```
+
+The jar can be found in `./build/libs/`
+
+### Maven
+
 The alternative way to build a usable jar for testing will be
+
 ```
 mvn clean install -Dmaven.test.skip=true
 ```
 
 The following command can install dependencies for you.
+
 ```
 mvn package
 ```
 
+The jar can be found in `./target/`
+
+### Bazel
+
 Alternatively, you can use `bazel` for much faster build. When you try this approach, you should run `git submodule update --init --recursive` before you build project.
 
 Making a uber jar:
+
 ```
 make uber_jar
 ```
+
 run Main class:
+
 ```
 make run
 ```
 
 run test cases:
+
 ```
 make test
 ```
@@ -39,8 +70,9 @@ this project is designed to hook with `pd` and `tikv` which you can find in `Pin
 
 When you work with this project, you have to communicate with `pd` and `tikv`. Please run TiKV and PD in advance.
 
-## Raw TiKV-Client in Java
-Java Implementation of Raw TiKV-Client
+## Component: Raw Ti-Client in Java
+
+Java Implementation of Raw TiKV-Client to support RawKVClient commands.
 
 Demo is avaliable in [KVRawClientTest](https://github.com/birdstorm/KVRawClientTest/)
 
@@ -49,79 +81,94 @@ Demo is avaliable in [KVRawClientTest](https://github.com/birdstorm/KVRawClientT
 mvn clean install -Dmaven.test.skip=true
 ```
 
-### Use as maven dependency
-After building, add following lines into your `pom.xml` 
+### Add to dependency
+
+#### Use jar for binary
+
+Add your jar built with all dependencies into you project's library to use `tikv-client-java` as dependency
+
+#### Use as maven dependency
+
+After building, add following lines into your `pom.xml` if you are using Maven
+
 ```xml
 <dependency>
-    <groupId>org.tikv</groupId>
-    <artifactId>tikv-client-java</artifactId>
-    <version>2.0-SNAPSHOT</version>
+	<groupId>org.tikv</groupId>
+	<artifactId>tikv-client-java</artifactId>
+	<version>2.0-SNAPSHOT</version>
 </dependency>
 ```
 
 ### Entrance
-`com.pingcap.tikv.RawKVClient`
+`org.tikv.raw.RawKVClient`
 
-### API
+### Create a RawKVClient
 
 ```java
-  /**
-   * create a RawKVClient using specific pd addresses
-   *
-   * @param address pd addresses(comma seperated)
-   */
-  static RawKVClient create(String address)
+import org.tikv.common.TiSession;
+import org.tikv.raw.RawKVClient;
+
+public class Main {
+	public static void main() {
+		// You MUST create a raw configuration if you are using RawKVClient.
+		TiConfiguration conf = TiConfiguration.createRawDefault(YOUR_PD_ADDRESSES);
+		TiSession session = TiSession.create(conf);
+		RawKVClient = session.createRawKVClient();
+	}
+}
 ```
 
+### API
+
 ```java
-  /**
-   * Put a raw key-value pair to TiKV
-   *
-   * @param key raw key
-   * @param value raw value
-   */
-   void put(ByteString key, ByteString value)
+/**
+ * Put a raw key-value pair to TiKV
+ *
+ * @param key raw key
+ * @param value raw value
+ */
+void put(ByteString key, ByteString value)
 ```
 
 ```java
-  /**
-   * Get a raw key-value pair from TiKV if key exists
-   *
-   * @param key raw key
-   * @return a ByteString value if key exists, ByteString.EMPTY if key does not exist
-   */
-  ByteString get(ByteString key)
+/**
+ * Get a raw key-value pair from TiKV if key exists
+ *
+ * @param key raw key
+ * @return a ByteString value if key exists, ByteString.EMPTY if key does not exist
+ */
+ByteString get(ByteString key)
 ```
 
 ```java
-  /**
-   * Scan raw key-value pairs from TiKV in range [startKey, endKey)
-   *
-   * @param startKey raw start key, inclusive
-   * @param endKey raw end key, exclusive
-   * @return list of key-value pairs in range
-   */
-  List<Kvrpcpb.KvPair> scan(ByteString startKey, ByteString endKey)
+/**
+ * Scan raw key-value pairs from TiKV in range [startKey, endKey)
+ *
+ * @param startKey raw start key, inclusive
+ * @param endKey raw end key, exclusive
+ * @return list of key-value pairs in range
+ */
+List<Kvrpcpb.KvPair> scan(ByteString startKey, ByteString endKey)
 ```
 
 ```java
-  /**
-   * Scan raw key-value pairs from TiKV in range [startKey, endKey)
-   *
-   * @param startKey raw start key, inclusive
-   * @param limit limit of key-value pairs
-   * @return list of key-value pairs in range
-   */
-  List<Kvrpcpb.KvPair> scan(ByteString startKey, int limit)
+/**
+ * Scan raw key-value pairs from TiKV in range [startKey, endKey)
+ *
+ * @param startKey raw start key, inclusive
+ * @param limit limit of key-value pairs
+ * @return list of key-value pairs in range
+ */
+List<Kvrpcpb.KvPair> scan(ByteString startKey, int limit)
 ```
 
 ```java
-  /**
-   * Delete a raw key-value pair from TiKV if key exists
-   *
-   * @param key raw key to be deleted
-   */ 
-  void delete(ByteString key) 
+/**
+ * Delete a raw key-value pair from TiKV if key exists
+ *
+ * @param key raw key to be deleted
+ */ 
+void delete(ByteString key) 
 ```