Documentation

diff --git a/README.markdown b/README.markdown
deleted file mode 100644 (file)
index b57ec84..0000000
--- a/README.markdown
+++ /dev/null
@@ -1,86 +0,0 @@
-iciql\r
-=================\r
-\r
-[![Maven Central](http://img.shields.io/maven-central/v/com.gitblit.iciql/iciql.svg)](http://search.maven.org/#search|ga|1|com.gitblit.iciql)\r
-[![Maven Central](https://img.shields.io/github/license/gitblit/iciql.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)\r
-\r
-iciql **is**...\r
-\r
-- a model-based, database access wrapper for JDBC\r
-- for modest database schemas and basic statement generation\r
-- for those who want to write code, instead of SQL, using IDE completion and compile-time type-safety\r
-- small (<250KB with debug symbols) with no runtime dependencies\r
-- pronounced *icicle* (although it could be French: *ici ql* - here query language)\r
-- a friendly fork of the H2 [JaQu](http://h2database.com/html/jaqu.html) project\r
-\r
-iciql **is not**...\r
-\r
-- a complete alternative to JDBC\r
-- designed to compete with more powerful database query tools like [jOOQ](http://jooq.sourceforge.net) or [QueryDSL](http://source.mysema.com/display/querydsl/Querydsl)\r
-- designed to compete with enterprise ORM tools like [Hibernate](http://www.hibernate.org) or [mybatis](http://www.mybatis.org)\r
-\r
-Supported Databases (Unit-Tested)\r
--------\r
-- [H2](http://h2database.com) 1.4\r
-- [HSQLDB](http://hsqldb.org) 2.3\r
-- [Derby](http://db.apache.org/derby) 10.12\r
-- [MySQL](http://mysql.com) 5.6\r
-- [PostgreSQL](http://postgresql.org) 9.5\r
-- [SQLite](http://www.sqlite.org) 3.8\r
-\r
-Support for others is possible and may only require creating a simple "dialect" class.\r
-\r
-Downloading\r
------------\r
-\r
-As of 2.0.0 iciql is now distributed through Maven Central and it's coordinates have changed slightly.\r
-\r
-```xml\r
-<dependencies>\r
-    <dependency>\r
-        <groupId>com.gitblit.iciql</groupId>\r
-        <artifactId>iciql</artifactId>\r
-        <version>2.0.0/version>\r
-    </dependency>\r
-</dependencies>\r
-```\r
-\r
-Older releases are available from the [Iciql Maven Repository](http://gitblit.github.io/iciql/maven/). \r
-\r
-License\r
--------\r
-iciql is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).<br/>\r
-The text of the license is included in the file LICENSE in the root of the project.\r
-\r
-Java Runtime Requirement\r
--------\r
-iciql requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK).\r
- \r
-Getting help\r
--------\r
-Read the online documentation available at the [iciql website](http://iciql.com)<br/>\r
-Issues & source code @ [GitHub](http://github.com/gitblit/iciql)\r
-\r
-Building iciql\r
-----------------\r
-\r
-## Maven\r
-\r
-You may use Maven to build the project:\r
-\r
-    mvn clean package\r
-    \r
-You may use Maven to run the test suite on the default database:\r
-\r
-    mvn clean test\r
-\r
-## Ant\r
-\r
-You may use Ant to build this project:\r
-\r
-    ant clean build\r
-    \r
-You may execute the full test suite against all tested databases:\r
- \r
-     ant testsuite\r
-\r

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..b57ec84
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+iciql\r
+=================\r
+\r
+[![Maven Central](http://img.shields.io/maven-central/v/com.gitblit.iciql/iciql.svg)](http://search.maven.org/#search|ga|1|com.gitblit.iciql)\r
+[![Maven Central](https://img.shields.io/github/license/gitblit/iciql.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)\r
+\r
+iciql **is**...\r
+\r
+- a model-based, database access wrapper for JDBC\r
+- for modest database schemas and basic statement generation\r
+- for those who want to write code, instead of SQL, using IDE completion and compile-time type-safety\r
+- small (<250KB with debug symbols) with no runtime dependencies\r
+- pronounced *icicle* (although it could be French: *ici ql* - here query language)\r
+- a friendly fork of the H2 [JaQu](http://h2database.com/html/jaqu.html) project\r
+\r
+iciql **is not**...\r
+\r
+- a complete alternative to JDBC\r
+- designed to compete with more powerful database query tools like [jOOQ](http://jooq.sourceforge.net) or [QueryDSL](http://source.mysema.com/display/querydsl/Querydsl)\r
+- designed to compete with enterprise ORM tools like [Hibernate](http://www.hibernate.org) or [mybatis](http://www.mybatis.org)\r
+\r
+Supported Databases (Unit-Tested)\r
+-------\r
+- [H2](http://h2database.com) 1.4\r
+- [HSQLDB](http://hsqldb.org) 2.3\r
+- [Derby](http://db.apache.org/derby) 10.12\r
+- [MySQL](http://mysql.com) 5.6\r
+- [PostgreSQL](http://postgresql.org) 9.5\r
+- [SQLite](http://www.sqlite.org) 3.8\r
+\r
+Support for others is possible and may only require creating a simple "dialect" class.\r
+\r
+Downloading\r
+-----------\r
+\r
+As of 2.0.0 iciql is now distributed through Maven Central and it's coordinates have changed slightly.\r
+\r
+```xml\r
+<dependencies>\r
+    <dependency>\r
+        <groupId>com.gitblit.iciql</groupId>\r
+        <artifactId>iciql</artifactId>\r
+        <version>2.0.0/version>\r
+    </dependency>\r
+</dependencies>\r
+```\r
+\r
+Older releases are available from the [Iciql Maven Repository](http://gitblit.github.io/iciql/maven/). \r
+\r
+License\r
+-------\r
+iciql is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).<br/>\r
+The text of the license is included in the file LICENSE in the root of the project.\r
+\r
+Java Runtime Requirement\r
+-------\r
+iciql requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK).\r
+ \r
+Getting help\r
+-------\r
+Read the online documentation available at the [iciql website](http://iciql.com)<br/>\r
+Issues & source code @ [GitHub](http://github.com/gitblit/iciql)\r
+\r
+Building iciql\r
+----------------\r
+\r
+## Maven\r
+\r
+You may use Maven to build the project:\r
+\r
+    mvn clean package\r
+    \r
+You may use Maven to run the test suite on the default database:\r
+\r
+    mvn clean test\r
+\r
+## Ant\r
+\r
+You may use Ant to build this project:\r
+\r
+    ant clean build\r
+    \r
+You may execute the full test suite against all tested databases:\r
+ \r
+     ant testsuite\r
+\r

diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644 (file)
index 0000000..5c05e03
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,53 @@
+## Releasing
+
+These are quick notes on using Maven to release artifacts to Sonatype.
+
+### Snapshots
+
+To release a snapshot to [Sonatype OSS Snapshots repository](https://oss.sonatype.org/content/repositories/snapshots/):
+
+    mvn clean deploy
+
+### Releases
+
+Releases are deployed to [Sonatype OSSRH Staging](http://central.sonatype.org/pages/releasing-the-deployment.html) and then manually synced to Central.
+
+To release with automated versioning and SCM integration:
+
+    mvn release:clean release:prepare
+    mvn release:perform
+
+To release manually:
+
+    mvn versions:set -DnewVersion=1.2.3
+    mvn clean deploy -P release
+
+### Settings.xml
+
+Sonatype uploads are authenticated and require credentials.
+GPG signing requires a passphrase to unlock the signing key.
+Both of these secrets can be stored in `~/.m2/settings.xml`.
+
+```xml
+<settings>
+  <servers>
+    <server>
+      <id>ossrh</id>
+      <username>jira-username</username>
+      <password>jira-password</password>
+    </server>
+  </servers>
+  <profiles>
+    <profile>
+      <id>ossrh</id>
+      <activation>
+        <activeByDefault>true</activeByDefault>
+      </activation>
+      <properties>
+        <gpg.executable>gpg</gpg.executable>
+        <gpg.passphrase>gpg-password</gpg.passphrase>
+      </properties>
+    </profile>
+  </profiles>
+</settings>
+```