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