From c6607f24aa8e23d1a680c6a4fa5e80b503d6c54a Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Tue, 28 Oct 2014 10:18:39 -0400 Subject: [PATCH] Update README with additional help --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 448409b..261f56e 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#Node-query +#CI-Node-query A node query builder for various SQL databases, based on CodeIgniter's query builder. @@ -33,4 +33,10 @@ A node query builder for various SQL databases, based on CodeIgniter's query bui .get(function(/* Adapter dependent arguments */) { // Database module result handling }); + +### Additional help + +* Generated documentation is in the docs/ folder +* `tests/query-builder-base.js` contains a lot of usage examples +* The `tests/adapters` folder contains examples of how to set up a connection for the appropriate database library