added docs script and updated readme

firebase · Jul 30, 2014 · 0d5af04 · 0d5af04
1 parent fff5a33
commit 0d5af04
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,6 @@
 
 # Maven
 target
+
+# Other
+/site/docs
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ You can also directly add the jar file in the folder `dist` to your project.
 
 ## API Reference
 
-*TODO: add link to API reference*
+A full API reference is available [here](https://geofire-java.firebaseapp.com/docs/").
 
 ## Quick Start
 

diff --git a/create-docs.sh b/create-docs.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+set -e
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+echo "Generating javadocs..."
+mvn javadoc:javadoc
+
+echo "Renaming output folder"
+rm -rf "$DIR/site/docs"
+mv "$DIR/target/site/apidocs" "$DIR/site/docs"
diff --git a/firebase.json b/firebase.json
@@ -0,0 +1,9 @@
+{
+  "firebase": "geofire-java",
+  "public": "site",
+  "ignore": [
+    "firebase.json",
+    "**/.*",
+    "**/node_modules/**"
+  ]
+}
diff --git a/site/index.html b/site/index.html
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>GeoFire for Java</title>
+  </head>
+
+  <body style="width: 800px; margin: auto;">
+    <h1 style="text-align: center;">GeoFire for iOS</h1>
+
+    <h2>API Reference</h2>
+    <p>
+      A full API reference for GeoFire for Java is available <a href="docs/index.html">here</a>.
+    </p>
+
+    <h2>Quick Start</h2>
+    <p>
+      Check out <a href="https://github.com/firebase/geofire-java/">GitHub</a> for a quick start guide and examples.
+    </p>
+
+    <h2>Source Code</h2>
+    <p>
+      GeoFire for Java is open source and available on <a href="https://github.com/firebase/geofire-java">GitHub</a>
+    </p>
+
+    <h2>Other version</h2>
+    <p>
+      Other versions of GeoFire are available fore <a href="https://github.com/firebase/geofire">JavaScript</a> and <a
+        href="https://github.com/firebase/geofire-ios">iOS</a>.
+    </p>
+  </body>
+</html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,3 +9,6 @@ @@
     # Maven
     target
+    # Other
+    /site/docs