updated readme

This commit is contained in:
Willem 2016-11-19 22:35:06 +01:00
parent 8cdb325e8c
commit 41f311ed50

View file

@ -1,27 +1,29 @@
FF-TPQuery FF-TPQuery
========= =========
FF-TPQuery is a java8 library providing templated prepared statements. FF-TPQuery is a java8 library providing templated prepared statements with native parameter support.
## Features ## Features
* Named parameters * Named parameters.
* Include query parts * Include query parts.
* Default values * Default values.
* Extra parameter types like LIST and RAW * Extra parameter types like LIST and RAW.
* QuerySets are nestable. * QuerySets are nestable.
* Prepared statement cache if possibe. * Prepared statement cache if possibe.
* Multiple languages supported. * Multiple languages supported.(SQL and HQL)
* Validation * Custom feature validation.
* Rich query builder api.
* Loadable query trees from xml.
## Installation ## Installation
Add maven deps; Add maven dep for jpa usage;
<dependency> <dependency>
<groupId>net.forwardfire.tpquery</groupId> <groupId>net.forwardfire.tpquery</groupId>
<artifactId>ff-tpquery-store</artifactId> <artifactId>ff-tpquery-executor-jpa</artifactId>
<version>1.5.0-SNAPSHOT</version> <version>1.5.1-SNAPSHOT</version>
<scope>compile</scope> <scope>compile</scope>
</dependency> </dependency>
@ -33,8 +35,8 @@ FF-TPQuery is a java8 library providing templated prepared statements.
* readme.md - This file. * readme.md - This file.
* todo.md - Small todo list. * todo.md - Small todo list.
* src - site source. * src - site source.
* ff-tpquery-executor-jdbc - Jdbc executor implementation. * ff-tpquery-executor-jdbc - Jdbc executor implementation. (SQL only)
* ff-tpquery-executor-jpa - JPA executor implementation. * ff-tpquery-executor-jpa - JPA executor implementation. (SQL and HQL)
* ff-tpquery-store - The query store library. * ff-tpquery-store - The query store library.
## Contributing ## Contributing
@ -44,8 +46,12 @@ Add unit tests for any new or changed functionality. Style and test your code.
## Release History ## Release History
### Version 1.5.0 ### Version 1.5.1-SNAPSHOT
* First public release * Fixed execute dep artifact typo.
* Updated all dep versions.
### Version 1.5.0-SNAPSHOT
* First public release.
* fifth rewrite of idea. * fifth rewrite of idea.