1 files changed, 44 insertions, 0 deletions

diff --git a/java/com/xagasoft/gats/package-info.java b/java/com/xagasoft/gats/package-info.java
new file mode 100644
index 0000000..9f4824e
--- /dev/null
+++ b/java/com/xagasoft/gats/package-info.java
@@ -0,0 +1,44 @@
+/**
+ * The Generalized Agile Transport System.
+ *
+ * This package contains interfaces for working with GATS.  GATS is used to
+ * serialize data structures to and from storage as well as over the network.
+ * <p>
+ * GATS has a number of advantages over other systems for doing serialization.
+ * <ul>
+ *  <li>GATS is a binary storage system, so values are stored accurately
+ *      and compactly.</li>
+ *  <li>GATS is arbitrary precision.  There is no upper bound on any integers
+ *      or floating point values stored in gats.</li>
+ *  <li>GATS is platform, language, and endiness agnostic.  Data transmitted or
+ *      stored using GATS can be received, read, and used on any platform
+ *      without worries.  The binary format of GATS does <b>not</b> change
+ *      dependant on the archetecture.</li>
+ *  <li>GATS gurantees no loss of precision for floating point numbers.  When
+ *      storing floating point numbers a binary format similar to that employed
+ *      by computer hardware is used.  All exceptional cases are also preserved,
+ *      including +/- infinity, NaN, etc.</li>
+ *  <li>GATS offers a generalized hierarchical data structure much like many
+ *      textual encoding/storage systems like json, xml, yaml, etc.</li>
+ *  <li>GATS is designed with efficient transmission, compression, and
+ *      encryption in mind which makes it an excellent choice as the underlying
+ *      format for modern protocols.</li>
+ * </ul>
+ *
+ * GATS uses a generalized data structure for storing data which
+ * supports the following data types:
+ * <ul>
+ *      <li>dictionaries</li>
+ *      <li>lists</li>
+ *      <li>booleans</li>
+ *      <li>integers</li>
+ *      <li>floats</li>
+ *      <li>strings</li>
+ * </ul>
+ *
+ * Please see {@link com.xagasoft.gats.GatsOutputStream} for more information
+ * about how GATS is encoded.
+ *
+ *@author Mike Buland
+ */
+package com.xagasoft.gats;