README: updated documentation

anhldbk · Mar 22, 2020 · 6093724 · 6093724
1 parent 893cfbb
commit 6093724
Show file tree

Hide file tree

Showing 28 changed files with 80 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -118,8 +118,60 @@ public class Meta {
 }
 ```
 
-## Installation
+## Usage
+
+### Installation
 
 ```bash
 $ scripts/local-install.sh
 ```
+
+### Dependency
+
+```xml
+<dependency>
+    <groupId>org.apache.avro</groupId>
+    <artifactId>avro</artifactId>
+    <version>1.10.0.avro-2723</version>
+</dependency>
+
+```
+
+### Code 
+
+Simply just use normal Java code, no additional annotations.
+
+```java
+public class Human {
+  String name = "Andy";
+  ArrayList<Human> friends = new ArrayList<>();
+}
+
+ReflectData.UseInitialValueAsDefault reflect = ReflectData.UseInitialValueAsDefault.get();
+Schema schema = reflect.getSchema(Human.class);
+
+System.out.println(schema.toString(true));
+```
+
+The output:
+
+```json
+{
+  "type" : "record",
+  "name" : "Human",
+  "namespace" : "org.apache.avro.reflect.TestReflectUseInitialValueAsDefault",
+  "fields" : [ {
+    "name" : "name",
+    "type" : [ "null", "string" ],
+    "default" : "Andy"
+  }, {
+    "name" : "friends",
+    "type" : [ "null", {
+      "type" : "array",
+      "items" : "Human",
+      "java-class" : "java.util.ArrayList"
+    } ],
+    "default" : [ ]
+  } ]
+}
+```
diff --git a/lang/java/archetypes/avro-service-archetype/pom.xml b/lang/java/archetypes/avro-service-archetype/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-archetypes-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

diff --git a/lang/java/archetypes/pom.xml b/lang/java/archetypes/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <groupId>org.apache.avro</groupId>
     <artifactId>avro-parent</artifactId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

diff --git a/lang/java/avro/pom.xml b/lang/java/avro/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/compiler/pom.xml b/lang/java/compiler/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/grpc/pom.xml b/lang/java/grpc/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <groupId>org.apache.avro</groupId>
     <artifactId>avro-parent</artifactId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/integration-test/codegen-test/pom.xml b/lang/java/integration-test/codegen-test/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-integration-test</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/integration-test/pom.xml b/lang/java/integration-test/pom.xml
@@ -23,7 +23,7 @@
   <parent>
       <artifactId>avro-parent</artifactId>
       <groupId>org.apache.avro</groupId>
-      <version>1.10.0-SNAPSHOT</version>
+      <version>1.10.0.avro-2723</version>
       <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/integration-test/test-custom-conversions/pom.xml b/lang/java/integration-test/test-custom-conversions/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-integration-test</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/ipc-jetty/pom.xml b/lang/java/ipc-jetty/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/ipc-netty/pom.xml b/lang/java/ipc-netty/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/ipc/pom.xml b/lang/java/ipc/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/mapred/pom.xml b/lang/java/mapred/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/maven-plugin/pom.xml b/lang/java/maven-plugin/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/maven-plugin/src/test/resources/unit/idl/pom.xml b/lang/java/maven-plugin/src/test/resources/unit/idl/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../../../../../../../../../pom.xml</relativePath>
   </parent>
 

diff --git a/lang/java/maven-plugin/src/test/resources/unit/protocol/pom.xml b/lang/java/maven-plugin/src/test/resources/unit/protocol/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../../../../../../../../../pom.xml</relativePath>
   </parent>
 

diff --git a/lang/java/maven-plugin/src/test/resources/unit/schema/pom.xml b/lang/java/maven-plugin/src/test/resources/unit/schema/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../../../../../../../../../pom.xml</relativePath>
   </parent>
 

diff --git a/lang/java/perf/pom.xml b/lang/java/perf/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/pom.xml b/lang/java/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <groupId>org.apache.avro</groupId>
     <artifactId>avro-toplevel</artifactId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../../</relativePath>
   </parent>
 

diff --git a/lang/java/protobuf/pom.xml b/lang/java/protobuf/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/thrift/pom.xml b/lang/java/thrift/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/tools/pom.xml b/lang/java/tools/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/trevni/avro/pom.xml b/lang/java/trevni/avro/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <artifactId>trevni-java</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/trevni/core/pom.xml b/lang/java/trevni/core/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <artifactId>trevni-java</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/lang/java/trevni/doc/pom.xml b/lang/java/trevni/doc/pom.xml
@@ -22,7 +22,7 @@
   <parent>
     <artifactId>trevni-java</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>..</relativePath>
   </parent>
 

diff --git a/lang/java/trevni/pom.xml b/lang/java/trevni/pom.xml
@@ -23,7 +23,7 @@
   <parent>
     <artifactId>avro-parent</artifactId>
     <groupId>org.apache.avro</groupId>
-    <version>1.10.0-SNAPSHOT</version>
+    <version>1.10.0.avro-2723</version>
     <relativePath>../</relativePath>
   </parent>
 

diff --git a/pom.xml b/pom.xml
@@ -27,7 +27,7 @@
 
   <groupId>org.apache.avro</groupId>
   <artifactId>avro-toplevel</artifactId>
-  <version>1.10.0-SNAPSHOT</version>
+  <version>1.10.0.avro-2723</version>
   <packaging>pom</packaging>
 
   <name>Apache Avro Toplevel</name>

diff --git a/share/VERSION.txt b/share/VERSION.txt
@@ -1 +1 @@
-1.10.0-SNAPSHOT
+1.10.0.avro-2723