Browse Source

Merge pull request #29 from youny626/branch-0.5.0

Add README
Jin Hai 5 years ago
parent
commit
e032b7c530
2 changed files with 44 additions and 2 deletions
  1. 2 1
      CHANGELOG.md
  2. 42 1
      README.md

+ 2 - 1
CHANGELOG.md

@@ -20,4 +20,5 @@
 - \#1: First implementation
 - \#1: First implementation
 - \#21: Add javadoc
 - \#21: Add javadoc
 - \#23: Format code with Google-java-style and add Apache 2.0 license header
 - \#23: Format code with Google-java-style and add Apache 2.0 license header
-- \#28: add examples
+- \#28: add examples
+- \#29: add README

+ 42 - 1
README.md

@@ -1 +1,42 @@
-# milvus-sdk-java
+# milvus-sdk-java
+
+[![Maven Central](https://img.shields.io/maven-central/v/io.milvus/milvus-sdk-java.svg)](https://search.maven.org/artifact/io.milvus/milvus-sdk-java/)
+
+Java SDK for Milvus distributed high-performance vector search engine. 
+If you want to contribute to this repo, please read our [contribution guidelines]().
+
+## Getting started
+
+### Dependency 
+
+Apache Maven
+```xml
+<dependency>
+    <groupId>io.milvus</groupId>
+    <artifactId>milvus-sdk-java</artifactId>
+    <version>0.1.1</version>
+</dependency>
+```
+
+Gradle/Grails 
+
+`compile 'io.milvus:milvus-sdk-java:0.1.0'`
+
+###Examples
+
+Please refer to [examples](https://github.com/milvus-io/milvus-sdk-java/tree/master/examples) folder
+
+###Documentation
+
+- [Javadoc](https://milvus-io.github.io/milvus-sdk-java/javadoc/index.html)
+- [Milvus doc](https://milvus.io/docs/en/userguide/install_milvus/)
+
+###Additional information
+
+- The Java source code is formatted using [google-java-format](https://github.com/google/google-java-format).
+
+
+
+
+
+