README.rdoc in veritas-sql-generator-0.0.4 vs README.rdoc in veritas-sql-generator-0.0.5
- old
+ new
@@ -2,9 +2,26 @@
Relational algebra SQL generator
http://travis-ci.org/dkubb/veritas-sql-generator.png
+== Usage
+
+ # visit every node in the relation AST
+ generator = Veritas::SQL::Generator::Relation.visit(relation)
+
+ # generate an SQL string
+ sql = generator.to_sql
+
+ # generate an SQL subquery string
+ subquery_sql = generator.to_subquery
+
+== Description
+
+The purpose of this gem is to produce valid SQL from a veritas[https://github.com/dkubb/veritas] relation. A relation is a representation of a query constructed using relational algebra organized into an AST. Each node in the AST corresponds to an operation defined in the algebra.
+
+The SQL produced has been verified and tested against PostgreSQL 9.0.4. Dialects for MySQL, SQLite3, Oracle and SQL Server are planned.
+
== Note on Patches/Pull Requests
* If you want your code merged into the mainline, please discuss
the proposed changes with me before doing any work on it. This
library is still in early development, and it may not always be