Updated README and fixed some Javadoc errors.

README.md

@@ -0,0 +1,37 @@
+odiago-avro
+===========
+
+Extensions to the [Apache Avro](http://avro.apache.org) project for
+working with [Apache Hadoop](http://hadoop.apache.org).  Many of the
+components in this project may be moved into the Avro project
+eventually, though this repository serves as a good home for the
+application-level features not part of the Avro core.
+
+
+### Features
+
+* `org.apache.hadoop.io.AvroSequenceFile` - A wrapper around a Hadoop
+  SequenceFile that supports reading and writing Avro data.
+* `org.apache.avro.mapreduce` - A package for using Avro as
+  input/output records from a Hadoop MapReduce job using the new API.
+* `org.apache.avro.io.AvroDatumConverter` - Convert between Hadoop IO
+  types (`Text`, `IntWritable`) to Avro-mapped Java types
+  (`CharSequence`, `Integer`).
+* `org.apache.avro.io.AvroKeyValue` - Work with key-value pairs that
+  can be serialized and deserialized from Avro conatiner files.
+* `org.apache.avro.util.AvroCharSequenceComparator` - Work with any
+  Java CharSequence implementation of the Avro `"string"` type.
+* `org.apache.avro.file.SortedKeyValueFile` - Store sorted key-value
+  pairs in an indexed Avro container file (like a Hadoop MapFile).
+
+
+### How to build
+
+To build `target/odiago-avro-${project.version}.jar` run:
+
+    mvn package
+
+
+### Documentation
+
+* [Java API (Javadoc)](http://wibidata.github.com/odiago-avro/1.0.5/apidocs/)

pom.xml

@@ -1,4 +1,8 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project
+  xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
+>
   <modelVersion>4.0.0</modelVersion>
 
   <groupId>com.odiago.avro</groupId>
@@ -11,28 +15,16 @@
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+
+    <java.version>1.6</java.version>
+    <maven.compiler.source>${java.version}</maven.compiler.source>
+    <maven.compiler.target>${java.version}</maven.compiler.target>
+
+    <scm.connection>scm:git:ssh://git@github.com/wibidata/odiago-avro.git</scm.connection>
   </properties>
 
   <build>
     <plugins>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-compiler-plugin</artifactId>
-        <version>2.3.2</version>
-        <configuration>
-          <source>1.6</source>
-          <target>1.6</target>
-          <showWarnings>true</showWarnings>
-        </configuration>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-release-plugin</artifactId>
-        <version>2.1</version>
-        <configuration>
-          <pushChanges>false</pushChanges>
-        </configuration>
-      </plugin>
       <plugin>
         <groupId>org.apache.avro</groupId>
         <artifactId>avro-maven-plugin</artifactId>
@@ -48,6 +40,25 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.8</version>
+        <configuration>
+          <links>
+            <link>http://archive.cloudera.com/cdh/3/hadoop-0.20.2-cdh3u0/api</link>
+          </links>
+          <reportOutputDirectory>target/apidocs</reportOutputDirectory>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>javadoc</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 
@@ -123,9 +134,9 @@
   </distributionManagement>
 
   <scm>
-    <connection>scm:git:ssh://git@git.odiago.com/avro.git</connection>
-    <url>scm:git:ssh://git@git.odiago.com/avro.git</url>
-    <developerConnection>scm:git:ssh://git@git.odiago.com/avro.git</developerConnection>
+    <connection>${scm.connection}</connection>
+    <url>${scm.connection}</url>
+    <developerConnection>${scm.connection}</developerConnection>
   </scm>
 
   <profiles>

src/main/java/org/apache/avro/io/AvroDeserializer.java

@@ -18,7 +18,7 @@
  * objects and deserialization is handled by this class.</p>
  *
  * <p>MapReduce jobs that use AvroWrapper objects as keys or values need to be configured
- * with {@link org.apache.avro.mapreduce.AvroSerialization}.  Use {@link
+ * with {@link org.apache.avro.io.AvroSerialization}.  Use {@link
  * org.apache.avro.mapreduce.AvroJob} to help with Job configuration.</p>
  *
  * @param <T> The type of Avro wrapper.

src/main/java/org/apache/avro/io/AvroKeyDeserializer.java

@@ -11,7 +11,7 @@
  *
  * @param <D> The java type of the avro data to deserialize.
  *
- * @see org.apache.avro.mapreduce.AvroDeserializer
+ * @see org.apache.avro.io.AvroDeserializer
  */
 public class AvroKeyDeserializer<D> extends AvroDeserializer<AvroWrapper<D>, D> {
   /**

src/main/java/org/apache/avro/io/AvroSerializer.java

@@ -19,7 +19,7 @@
  * class.</p>
  *
  * <p>MapReduce jobs that use AvroWrapper objects as keys or values need to be configured
- * with {@link org.apache.avro.mapreduce.AvroSerialization}.  Use {@link
+ * with {@link org.apache.avro.io.AvroSerialization}.  Use {@link
  * org.apache.avro.mapreduce.AvroJob} to help with Job configuration.</p>
  *
  * @param <T> The Java type of the Avro data.

src/main/java/org/apache/avro/io/AvroValueDeserializer.java

@@ -11,7 +11,7 @@
  *
  * @param <D> The java type of the avro data to deserialize.
  *
- * @see org.apache.avro.mapreduce.AvroDeserializer
+ * @see org.apache.avro.io.AvroDeserializer
  */
 public class AvroValueDeserializer<D> extends AvroDeserializer<AvroWrapper<D>, D> {
   /**

src/main/java/org/apache/avro/mapreduce/AvroKeyOutputFormat.java

@@ -36,7 +36,7 @@ public AvroKeyOutputFormat() {
   /**
    * Constructor.
    *
-   * @param recordwriterfactory A factory for creating record writers.
+   * @param recordWriterFactory A factory for creating record writers.
    */
   protected AvroKeyOutputFormat(RecordWriterFactory recordWriterFactory) {
     mRecordWriterFactory = recordWriterFactory;